Vim-prettier: Update DOC's and README

Created on 30 Jan 2018  路  6Comments  路  Source: prettier/vim-prettier

It has been a long time since we updated the README, and it feels like we just keep adding new extensions on the code usage. We should make sure we have a very clear and unambiguous README, some FAQ area and a clear examples of suggestions of integrations.

Would be amazing if someone from the community could tackle this work :)

good-first-issue help wanted

Most helpful comment

@mitermayer Sure, I'll try my best.

All 6 comments

I would like to update the readme, but firstly what are your specific expectations? Like you can list down some to-dos and I'll see what I can do.

Hi @huyvohcmc, thank you very much for offering! that would be awesome!

I will get back to you as soon as possible with some more information around it.

Hi @huyvohcmc ,

I am currently working on vim-prettier 1.0 there will be some config and default changes, if you are still interested once we have a beta version I can provide you a list of changes and you can have free power to fully re-edit the README and docs to better explain the changes.

I was also thinking about including a FAQ section area on the front. If this is something that would interest you I can try to reach you offline and we can work together on it

@mitermayer Sure, I'll try my best.

Getting close to having all features for 1.x developed then we will get back to this issue

This is being handled on the release/1.x branch

Was this page helpful?
0 / 5 - 0 ratings

Related issues

gko picture gko  路  5Comments

alex-shamshurin picture alex-shamshurin  路  10Comments

ajcrites picture ajcrites  路  8Comments

cdimitroulas picture cdimitroulas  路  5Comments

jrock2004 picture jrock2004  路  5Comments