/readme-template-for-projects

This repo is to show what a detailed README should include. This README is written and styled in Markdown. You can edit this eitehr in the browser or your code editor. VScode does have a Markdown extension which will show you the syntax highlighting.

forthebadge

Package Control total downloads

A Template For Quick and Awesome README's. Give your project the README it deserves!

This repo is built to be an example of what a detailed README should include. The best part is you can use it over and over again, reducing the tedious and time consuming task of rewriting a README for every project. This README is written and styled in Markdown. You can edit this either in the browser or your code editor. VScode does have a Markdown extension which will show you the syntax highlighting.

Visitor CountVisitors, connect with me on linkedin

swagger made-with-Markdown stars-shield stars-shield Maintenance Documentation Status GitHub license GitHub issues code-blooded

forthebadge


DigitalCrafts Project

**DigitalCrafts Houston Full-Stack Developer** Description of what the repo contains ie. "Immersive program week 4 course-work. This repo contains primarly JavaScript related coursework including; assignments, practice,activities and projects. During week 4 we covered JavaScript, Front-end, Validation, and manipulating the DOM."
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

![Product Name Screen Shot][product-screenshot]

I put this together to show what a detailed README is like. This README is written and styled in Markdown. You can edit this eitehr in the browser or your code editor. VScode does have a Markdown extension which will show you the syntax highlighting.

Why doing this detailed README is important:

  • Recruiters who looks at your project might not know how to reade code.
  • You an reuse it over and over again. Save time and work on your projects more by just editing this to match your next project!
  • You should element DRY principles to the rest of your life 😄

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, email

Built With

Getting Started

You should explain how to get your project up and running locally. EXAMPLE: To get a local copy up and running follow these simple steps.

Prerequisites

Here is an example of what this should contain and how to do it. If it is required for the project it should go here.

  • UUID
npm install npm@latest -g

Installation

  1. Clone to local machine
git clone https://github.com/github_username/repo_name.git
  1. Install NPM packages
npm install

  2. You need an API Key from https://example.com. Then add your API in config.js

const API_KEY = 'ENTER YOUR API';

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Project-Demo

Videos and Screenshots

Display videos, gifs are the easiest. Also include screenshots of the project, diffrent features or what not. dbzcode

Roadmap

Detail what you did as you do it. Add more info each time a feature is completed or a new feature is added/removed. You can also let people know of any known issues or new features by just linking to your: open issues.

Contributing

Either provide a CONTRIBUTING.md for details on how to contribute or list them as such:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @twitter_handle - email

Project Link: https://github.com/github_username/repo_name

Acknowledgements