A web application that helps automate README creation
Read: https://github.com/MLH-Fellowship/0.2.1-readme-dirs/wiki/Tree-Core-Architecure
Head to URL and type in your Github Project URL and watch a MarkDown Accessible README with pre-filled descriptions appear!
With a one-click Copy/Paste you can update your README with the best MarkDown Project Structure README's you've ever seen!
Example Github Project URL: https://github.com/MLH-Fellowship/0.2.1-readme-dirs
We built this tool two solve two major issues and two minor issues:
- README's don't contain project structures which make it difficult for contributors to understand where everything is and how what's happening inside the repository.
- Existing Project Structures don't have hyperlinks making the UX of a project structure a bit difficult to navigate with excessive scrolling or third party plugins to extend the functionality. This requires no third-party software and can be done right in Github natively!
- You can plug in any repo you want to contribute to and completely understand what every folder does thanks to auto generated documentation!
- You can attach Badges to your repository to help people find the correct NPM Package your repository references!
- React - To Build out the front-end application
- Github V3 REST API - To pull Tree Structures from Github Repositories
- JavaScript (ES6) - To execute API Requests
- TypeScript
- Styled Components (CSS-IN-JS Framework)
- HTML
- CSS
- Babel