NicMilli / WriteMe

AI generated ReadMe files for github

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

WriteMe

AI generated ReadMe files for github

Write-Me

GitHub package.json version GitHub GitHub issues Dependencies

Write-Me is an AI-powered ReadMe file generator.

Main Technologies Used:

React Express Mongoose Webpack Babel ESLint Nodemon Fontawesome

Description

This application aims to facilitate and streamline the process of creating comprehensive and professional README files.

Installation

First, clone the repository:

git clone https://github.com/NicMilli/WriteMe.git

Then, navigate into the cloned directory and install the necessary dependencies:

npm install

Usage

Here's a list of scripts you can use:

For development:

npm run dev
npm run client-dev
npm run server-dev

For production:

npm run build
npm run start

Contributing

If you find bugs, or have suggestions on how to improve the application, please feel free to open an issue or pull request.

License

This project is licensed under the ISC License.

Author

This app was created by Nicholas Milligan. If you have any questions, open an issue.

About

AI generated ReadMe files for github


Languages

Language:JavaScript 91.8%Language:CSS 8.2%