Add base README

[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)

• https://www.notion.so/10-10-2020-Initial-meetup-045736bedac3492fabe734b705e77e9c

Examples

• https://github.com/mapbox/mapbox-gl-js
• https://github.com/reduxjs/redux-toolkit
• https://github.com/commitizen/cz-cli
• https://github.com/eslint/eslint
• https://github.com/OpenAPITools/openapi-generator
• https://github.com/oreporan/color-tabs-vscode
• https://github.com/vavilon-js/vavilon.js
• https://github.com/NickKaramoff/shareon
• https://github.com/NickKaramoff/vue-tinybox
• https://github.com/NickKaramoff/pretty-money
• https://github.com/axios/axios
• https://github.com/reduxjs/redux-toolkit
• https://github.com/dotansimha/graphql-code-generator
• [and any othe opensource popular solution =) ]

[azinit]

take description, overview and plans

[lyf2000]

take get started

[azinit]

take table of contents too

[azinit]

take team