diff --git a/README.md b/README.md index b649c2a..739eb26 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,30 @@ -# Dev's Card +# DevsCard -Template for creating a comprehensive virtual CV for developers. +A fully customizable template you can use to create your online (and paper) resume without the need to write a single line of code. -## πŸš€ How to use +## Features -Just click this button πŸ‘‡ +- **✍️ Intellisense** β€” provide your data in TypeScript files, getting autocompletion and description of each property right in your IDE. +- **πŸ“±Β Responsiveness** β€” the resume is created and automatically tested to look good both on mobile and desktop devices. +- **🌠 Assets optimization** β€” all images in your CV are minimized and resized automatically at build time. +- **⚑️ Performance** β€” get 100 for all Lighthouse metrics, ensuring great experience for visitors and a high score for search engines. +- **πŸ“„ PDF generation** β€” generate an accompanying PDF version of your CV with one command. +- **πŸ”Ά Built-in icon sets** β€” choose from over 100 000 [Iconify](https://iconify.design/) icons to represent your skills. +- **🌍 I18n** β€” customize your resume's locale, date formatting, and used translations. +- **πŸ”Ž SEO friendly** β€” the entire website is designed with SEO in mind. All SEO-related config properties are required and well-described. +- **πŸ“Š Analytics** β€” built-in support for [Google Analytics](https://analytics.google.com/) and [Clarity](https://clarity.microsoft.com/). The only you need to do is provide their IDs. +- **🏭 Favicons generation** β€” invoke one command to generate all favicons and full app manifest for your website. +- **πŸ›  Data helpers** β€” use built-in helpers to define your skills/socials once and reuse them across the configuration. +- **πŸ”€ Data transformers** β€” utilize type-safe data transformers to create multiple variants of your resume without duplicating your data. -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/KonradSzwarc/devscard#NODE_VERSION=16) +## Documentation -This will create your own copy of this repository and trigger the deployment. All you need to do now is to go to your repository, populate `src/data.ts` with your own resume and push the changes πŸ”Ό +To learn how to set up your resume, go to: -## 🧞 Commands +[https://devscard.gitbook.io/docs](https://devscard.gitbook.io/docs/) -All commands are run from the root of the project, from a terminal: +## Example -| Command | Action | -| :--------------------- | :------------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:3000` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro preview` | -| `npm run astro --help` | Get help using the Astro CLI | +To see an example CV, visit the link below: + +[https://devscard.netlify.app](https://devscard.netlify.app/)