Skip to content

Update README, split into docs folder #64

@brainless

Description

@brainless

Lets refresh our README and create easier to follow documentation:

  • Create a docs/ folder to save multiple Markdown files to split our project documentation
  • Update README to make it minimal
  • Keep project features and links to getting started in README
  • Links to getting started should take user to new Markdown files in docs/
  • Separate document should exist get started for each major OS with sections for SmartCrawler, WebDriver and how to find further information by searching the web if needed
  • A separate document for current CLI options of SmartCrawler - this is agnostic of OSes and linked to main README

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions