Skip to content

readme-template.md

Latest commit

 

History

History
227 lines (159 loc) · 7.39 KB

readme-template.md

File metadata and controls

227 lines (159 loc) · 7.39 KB

Contributors Forks Stargazers Issues MIT License


Logo

Project Title

project_description. Remove the sections not needed for the new project.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

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_client, email, project_title, project_description

Built With

  • Next
  • React
  • Vue
  • Angular
  • Svelte
  • Laravel
  • Bootstrap
  • JQuery

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm 
    npm install npm@latest -g

Installation

  1. Get a free API Key at https://example.com
  2. Clone the repo 
    git clone https://github.com/github_username/repo_name.git
  3. Install NPM packages 
    npm install
  4. Enter 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 Documentation

Roadmap

  • Feature 1
  • Feature 2
  • Feature 3
    • Nested Feature

See the open issues for a full list of proposed features (and known issues).

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  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.txt for more information.

Contact

Anthony Ransley - software101.net@gmail.com

Project Link: https://github.com/Software101DotNet/CreateDotNetProject

Acknowledgments