juyung/devscard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
Konrad Szwarc 2023-01-28 20:00:41 +01:00
parent 71b39080bf
commit f756c0c8f2
4 changed files with 3 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -20,7 +20,7 @@ A fully customizable template to create your online (and paper) resume without w
To learn how to set up your resume, go to: To learn how to set up your resume, go to:
[https://devscard.gitbook.io/docs](https://devscard.gitbook.io/docs/) [https://devscard.gitbook.io/docs](https://devscard.gitbook.io/docs/setup-guide)
## Example ## Example

2
docs/README.md
View file

@ -1,7 +1,5 @@
# Introduction # Introduction
## What is DevsCard?
DevsCard is a fully customizable template to create your online resume without writing a single line of code. After forking the repository, you only need to update the initial data with your own and deploy the project. DevsCard is a fully customizable template to create your online resume without writing a single line of code. After forking the repository, you only need to update the initial data with your own and deploy the project.
Apart from the website template, DevsCard offers you plenty of additional features that will make it easier to take care of your online and offline presence, including: Apart from the website template, DevsCard offers you plenty of additional features that will make it easier to take care of your online and offline presence, including:

2
docs/SUMMARY.md
View file

@ -1,7 +1,7 @@
# Table of contents # Table of contents
- [Introduction](README.md) - [Introduction](README.md)
- [Setup guide](quick-setup-guide.md) - [Setup guide](setup-guide.md)
- [PDF generation](pdf-generation.md) - [PDF generation](pdf-generation.md)
- [Data transformation](data-transformation.md) - [Data transformation](data-transformation.md)

2
docs/quick-setup-guide.md → docs/setup-guide.md
View file

@ -35,7 +35,7 @@ To fill the CV with your data, go to the `src/data` directory. There you should
## 3. Generate PDF (optional) ## 3. Generate PDF (optional)
Within the main section, you will find an `action` property. It allows you to provide a pdf resume to download. If you don't have one, feel free to use our CV generator by invoking `npm run generate-pdf`. Generated resume will be placed in `public/cv.pdf` and use the same data as the web one. You can learn more about PDF generation [here](quick-setup-guide.md). Within the main section, you will find an `action` property. It allows you to provide a pdf resume to download. If you don't have one, feel free to use our CV generator by invoking `npm run generate-pdf`. Generated resume will be placed in `public/cv.pdf` and use the same data as the web one. You can learn more about PDF generation [here](./pdf-generation.md).
## 4. Deploy to Netlify ## 4. Deploy to Netlify