search

vadimdemedes / pastel

🎨 Next.js-like framework for CLIs made with Ink
https://term.ink/pastel
MIT License
2.2k stars 36 forks source link

Documentation Updates #36

Closed aaronsnig501 closed 1 year ago

aaronsnig501 commented 4 years ago

Firstly, I have updated the name of the README file, to match with the more conventional uppercase naming.

Secondly, I've gone through the existing documentation and tried to improve what was there. I personally found some areas to be unclear, especially surrounding the development process, so I've made some changes here to hopefully make it easier. I also removed the focus on how to manually set up the project. I felt that talking about the overall development process was more relevant than spending time talking about how to create a project without using create-pastel-app. I don't think that people would be very interested in setting up the project from scratch as they'd need to write all of the boilerplate and it's more error-prone and time-consuming than running the command.

Lastly, I ran the text through Grammarly to remove as many grammar issues in my own text, and the existing text as possible.

Hopefully, this will clear up any confusion for future developers and help to adopt more interest :)

vadimdemedes commented 1 year ago

I just shipped Pastel 2.0 where I rewrote documentation from scratch. Thanks for this PR and excuse me for a lack of review for such a long time.