Update README.md

This commit is contained in:
Amruth Pillai
2020-03-26 23:56:15 +05:30
committed by GitHub
parent 797f4b7bff
commit 31ca9fe890

View File

@ -11,6 +11,7 @@ Try it out today!
## Do you have a demo?
Why yes, I do! Click the thumbnail below to watch the app in action.
[![Demo Video of Reactive Resume](http://img.youtube.com/vi/4OM0LEPzDO8/0.jpg)](http://www.youtube.com/watch?v=4OM0LEPzDO8 "Reactive Resume")
## What's so special about it?
@ -50,6 +51,23 @@ Why yes, I do! Click the thumbnail below to watch the app in action.
Right now, I don't have many avenues for quick and easy contribution. If you are well versed in React + Tailwind CSS, you can design a few templates yourself. Otherwise, the best way you can contribute is to **star the repository**, **share the app with your friends**, and if possible, **leave some feedback on the app** so that I can better improve it.
## How do I run the project source?
I'm glad you asked :) Here is a step-by-step procedure on getting you started with installation and deployment of the application.
1. Download & Install Node.js (https://nodejs.org/), make sure you can run `npm` in the command line
2. `git clone https://github.com/AmruthPillai/Reactive-Resume.git`
3. `cd Reactive-Resume`
4. `npm install`
5. `npm start` - to start the development server
5. `npm run build` - to build a production version of the app
## Changelog
- Fixed Issue #2
- Added Markdown Support in Descriptions
- Added Gengar Template
## Why did you make this free?
A lot of people have asked me for help in designing their resumes as I have made mine. I just wanted a more natural way to generate resumes and have it easy to update cause updating a resume is always the uphill task. Once I thought of the idea, it was only a matter of time to design and develop the app. I am a big supporter of the open-source development movement as I have been directly benefitted by so many other projects that developers have shared. So needless to say, this project is entirely open-source and free as well :)