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

Less than perfectly clear README.md #11

Open
langdonx opened this issue Jun 6, 2017 · 3 comments
Open

Less than perfectly clear README.md #11

langdonx opened this issue Jun 6, 2017 · 3 comments

Comments

@langdonx
Copy link

langdonx commented Jun 6, 2017

Would it be reasonable to have README.md cover only information that doesn't exist in prettier's README.md? It took me a short while (had to comb through commits) to realize that the Options section includes both prettier and prettier-miscellaneous' options.

As well, it's a bit confusing to have README.md refer to the project as prettier, when it appears to be more than just your typical fork.

@rattrayalex
Copy link

Agreed. A README that only contains the additional options in prettier-misc and a link to the main prettier README may work better.

@rhengles
Copy link
Member

PR's accepted! ❤️

@lonix1
Copy link

lonix1 commented Feb 27, 2019

+1 to above

From what I can tell, these are the extra bits:

  • trailingComma
  • bracesSpacing
  • alignObjectProperties
  • spaceBeforeFunctionParen
  • cursorOffset

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants