Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.32 KB

README.md

File metadata and controls

61 lines (40 loc) · 2.32 KB
Raw

ReadmeWiz

Description

GitHub Profile README Generator is a web application that allows users to create custom GitHub profile README.md files using custom commands. This project is built using Vite React, making it fast, efficient, and easy to use.

With this tool, you can personalize your GitHub profile README.md and showcase your skills, projects, contact information, and more, all in a visually appealing way. Say goodbye to the static and boring GitHub profile READMEs and welcome an interactive and dynamic presentation of your profile.

Features

  • Custom Commands: Use simple and intuitive custom commands to add sections and content to your README.md file.
  • Preview: Instantly preview how your README.md will look while you're editing it.
  • Markdown Support: You can use standard Markdown syntax to format your content.
  • Live Editing: Changes are applied in real-time, providing a seamless editing experience.
  • Export: Easily export the generated README.md to your GitHub profile.

Demo

Check out the live demo of the GitHub Profile README Generator here.

Installation

To run this project locally, follow these steps:

  1. Clone the repository to your local machine.
  2. Navigate to the project's directory.
  3. Install dependencies using your preferred package manager (npm or yarn):
npm install
# or
yarn install
  1. Start the development server.
npm run dev
# or
yarn dev

The application should now be running on http://localhost:3000.

Usage/Examples

  1. Open READMEWizard in your browser.
  2. Click on the "Create" button to initiate the process.
  3. Follow the instructions to create a custom README.md with the features you desire.
  4. Copy the generated README.md content to your clipboard.
  5. Head to your GitHub profile and create a new public repository under your username.
  6. In the newly created repository, create a new file named README.md.
  7. Paste the copied README.md content into this newly created README.md file.
  8. Save the changes, and your custom GitHub profile README is now live on your profile!!

Thank you for using READMEWizard! I hope you find it helpful and enjoy customizing your GitHub profile with ease. If you encounter any problems or have suggestions for improvement, don't hesitate to reach out. Happy coding!