/imjord-Github-Readme-Generator

A readme generator made with node.js. when using you will need to change installation section towards your project. as it is now its for mern installs

Primary LanguageJavaScript

GitHub contributors GitHub forks GitHub Repo stars GitHub

imjord readme generator!

Create ReadMes For All Your Projects From The Command Line!

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

About The Project

I updated my readme generator to follow the template made by othneildrew/Best-README-Template

(back to top)

Built With

image image

(back to top)

Getting Started

If you would like to clone the repo hopefully this will help.

Prerequisites

node

Installation

  1. Clone the repo 
    git clone https://github.com/imjord/imjord-Github-Readme-Generator.git
  2. Install NPM packages in both client and server folders 
    npm install
  3. Run the start commands in both client and server folders(if there not their just do it from the root folder)(commands are in the package.json files). 
    npm start / npm run dev
  4. Enjoy! made with <3 by imjord

(back to top)

Usage

npm i in the root directory and run by using node index then follow the prompts!

(back to top)

Roadmap

  • [] better formating, make it more dynamic

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

(back to top)

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". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

MIT

(back to top)

Contact

Just message me on github mang <3 imjord

Project Link: https://github.com/imjord/imjord-Github-Readme-Generator

(back to top)