BeyondCodeBootcamp / BeyondCodeBootcamp/beyondcodebootcamp

Great README examples (documentation, markdown)

Open
#11 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
63
Forks
3
PR merge metrics
No merged PRs in 30d

Description

# What should a README be?

Projects should have READMEs that have

- Easy to understand the purpose
- At-a-glance visual usage / demo
- Actual demo
- Easy deploy instructions

# Great READMEs

- [Print-to-PDF HTML Resume](https://github.com/BeyondCodeBootcamp/html-resume)
- [Markdown Slides](https://github.com/dadoomer/markdown-slides)
- [XTZ.js](https://github.com/therootcompany/tz.js)
- [mssql-to-csv](https://github.com/therootcompany/mssql-to-csv)
- [README Template](https://github.com/othneildrew/Best-README-Template)

# Master Markdown

(honestly, it's easy)

- https://github.com/BeyondCodeBootcamp/beyondcodebootcamp/issues/2#markdown

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.