Skip to content

Add base README #1

@azinit

Description

@azinit

TODO

  • add section: description (Ilya)
    • base and short description
  • add section: table of contents (Ilya)
    • auto computed table of contents off README
  • add section: overview (Ilya)
    • +- short explanation of problem and little more details about solution
  • add section: get started (Damir)
    • quick start with module (how it should be - by your opinion)
    • add section: installing
      • installing process (yarn + npm)
    • add section: usage example
      • quick usage example (import / require without custom config)
  • add section: configuration
    • customization for project (how it should be - by your opinion)
  • add section: team (Ilya)
    • look at examples (there are example with users badges)
  • add section: faq (Ilya)
    • some specific cases / problems (how it should be - by your opinion)
  • add section: plans (Ilya)
    • about plans of product: script => npm module => vscode and etc.

Followup (10.10.2020)

Examples

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestwipWork in process

    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