Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add base README #1

Open
5 of 10 tasks
azinit opened this issue Oct 10, 2020 · 4 comments
Open
5 of 10 tasks

Add base README #1

azinit opened this issue Oct 10, 2020 · 4 comments
Labels
enhancement New feature or request wip Work in process

Comments

@azinit
Copy link
Member

azinit commented Oct 10, 2020

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

@azinit azinit added enhancement New feature or request wip Work in process labels Oct 10, 2020
@azinit
Copy link
Member Author

azinit commented Oct 10, 2020

take description, overview and plans

@lyf2000
Copy link
Collaborator

lyf2000 commented Oct 11, 2020

take get started

@azinit
Copy link
Member Author

azinit commented Oct 12, 2020

take table of contents too

@azinit
Copy link
Member Author

azinit commented Oct 12, 2020

take team

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request wip Work in process
Projects
None yet
Development

No branches or pull requests

2 participants