From bb7c671e3b2893ff114c2d0070034bcc62bb1cbb Mon Sep 17 00:00:00 2001 From: "MD. Ariful Alam" Date: Sun, 12 Sep 2021 21:46:05 +0600 Subject: [PATCH] Update README.md --- README.md | 77 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 50 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index b8f62dc..2d354a3 100644 --- a/README.md +++ b/README.md @@ -5,32 +5,38 @@

ezProfile

-

A modern, responsive and customizable portfolio template for Developers!

+

A modern, responsive and customizable portfolio builder for Developers!

+

https://arifszn.github.io/ezprofile


-https://user-images.githubusercontent.com/45073703/130999562-881227cb-d2bf-46a0-98b2-a7c7dad2664f.mp4 +

+ + Preview + +
+ Shadow +

-
- -**ezProfile** is an easy-to-customize personal dev portfolio template that is created with React.js. When you manage the code in a GitHub repository, it will automatically render a webpage with the owner's profile information, including a photo, bio, and public repositories. Also, it includes space to highlight your details, job history, education history, skills, and recent blog posts. +**ezProfile** is an easy-to-customize personal dev portfolio builder that is created with React.js. When you manage the code in a GitHub repository, it will automatically render a webpage with the owner's profile information, including a photo, bio, and public repositories. Also, it includes space to highlight your details, job history, education history, skills, and recent blog posts. It's all possible using [GitHub API](https://developer.github.com/v3/) (for automatically populating your website with content) and [Article-api](https://github.com/arifszn/article-api) (for fetching recent blog posts). -✔️ [21 Themes](#themes)\ -✔️ [Google Analytics](#google-analytics)\ -✔️ [Meta Tags](#meta-tags)\ -✔️ [Avatar and Bio](#avatar-and-bio)\ -✔️ [Social Links](#social-links)\ -✔️ [Skills](#skills)\ -✔️ [Experience](#experience)\ -✔️ [Education](#education)\ -✔️ [Projects](#projects)\ -✔️ [Blog Posts](#blog-posts) +✓ [21 Themes](#themes)\ +✓ [Google Analytics](#google-analytics)\ +✓ [Meta Tags](#meta-tags)\ +✓ [Avatar and Bio](#avatar-and-bio)\ +✓ [Social Links](#social-links)\ +✓ [Skills](#skills)\ +✓ [Experience](#experience)\ +✓ [Education](#education)\ +✓ [Projects](#projects)\ +✓ [Blog Posts](#blog-posts) To view a live example, **[click here](https://arifszn.github.io/ezprofile)**. + ## 🛠 Installation & Set Up These instructions will get you a copy of the project and deploy your website online! @@ -62,12 +68,12 @@ You can skip the above steps and do a manual deployment by running npm run As this is a create react app, you can also host your website to Netlify, Vercel, Heroku, or other popular services. Please refer to this [doc](https://create-react-app.dev/docs/deployment) for a detailed deployment guide to other services. If you see only README at username.github.io, be sure to change your GitHub Page's source to gh-pages branch. See [how to](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). - + ## 🎨 Customization -All the magic happens in file src/config. Open it and modify it according to your preference. +All the magic happens in the file src/config.js. Open it and modify it according to your preference. These are the default values: @@ -95,6 +101,7 @@ module.exports = { medium: '', devto: '', website: '', + phone: '', email: '' }, skills: [ @@ -182,8 +189,21 @@ module.exports = { ### Themes -There are 21 themes available which can be selected from the dropdown.\ -
+There are 21 themes available that can be selected from the dropdown. + +The default theme can be specified. + +```js +// config.js +module.exports = { + // ... + themeConfig: { + default: 'light', + // ... + } +} +``` + ![Theme Dropdown](https://arifszn.github.io/assets/img/hosted/ezprofile/themes-1.png) Here are some screenshots of different themes.\ @@ -196,7 +216,9 @@ Here are some screenshots of different themes.\
![Themes](https://arifszn.github.io/assets/img/hosted/ezprofile/themes-5.png)\
-![Themes](https://arifszn.github.io/assets/img/hosted/ezprofile/themes-6.png) +![Themes](https://arifszn.github.io/assets/img/hosted/ezprofile/themes-6.png)\ +
+![Themes](https://arifszn.github.io/assets/img/hosted/ezprofile/themes-7.png) ### Google Analytics @@ -214,7 +236,7 @@ module.exports = { Besides tracking visitors, ezFolio will track click events on projects and blog posts, and send them to Google Analytics.\
-![Google Analytics](https://arifszn.github.io/assets/img/hosted/ezprofile/event.png) +![Event](https://www.arifszn.com/assets/img/hosted/ezprofile/event.png) ### Meta Tags @@ -231,7 +253,7 @@ Your github avatar and bio will be displayed here.\ ### Social Links -ezProfile supports linking your social media services you're using, including LinkedIn, Twitter, Facebook, Dribbble, Behance, Medium, dev.to, personal website, and email. +ezProfile supports linking your social media services you're using, including LinkedIn, Twitter, Facebook, Dribbble, Behance, Medium, dev.to, personal website, phone and email. ```js // config.js module.exports = { @@ -245,6 +267,7 @@ module.exports = { medium: '', devto: '', website: 'https://arifszn.github.io', + phone: '', email: '' }, } @@ -253,7 +276,7 @@ module.exports = { ### Skills -To showcase your skills provide them in skills. +To showcase your skills provide them here. ```js // config.js module.exports = { @@ -344,7 +367,7 @@ module.exports = { ### Blog Posts -If you have [medium](https://medium.com) or [dev.to](https://dev.to) account, you can show your recent blog posts in here just by providing your medium/dev.to username. You can limit how many posts to display (Max is 10). +If you have [medium](https://medium.com) or [dev.to](https://dev.to) account, you can show your recent blog posts in here just by providing your medium/dev.to username. You can limit how many posts to display (Max is 10). ```js // config.js @@ -366,7 +389,7 @@ The posts are fetched by [Article-api](https://github.com/arifszn/article-api). ## 📢 Please Read -I intend to keep my works open source. Please do not discourage me by claiming this work by copying it as your own or removing the footer notice. +I intend to keep my works open source. Please do not discourage me by claiming this work by copying it as your own or removing/changing the footer notice. However You are open to use this project by forking it and change any code necessary(except footer notice). Go through the [License](https://github.com/arifszn/ezprofile/blob/main/LICENSE) before thinking of stealing this project. For every stolen copy found, an issue will be created on the concerned repo and a [DMCA Takedown](https://www.dmca.com/FAQ/What-is-a-DMCA-Takedown) notice will be sent. Do not fall into this [list](https://github.com/arifszn/ezprofile/issues/2). ## 💖 Support @@ -376,8 +399,8 @@ If you are using this project and happy with it or just want to encourage me to ## 💡 Contributing -Any contributors who want to make this website better can make contributions, which will be greatly appreciated. To contribute, clone this repo locally and commit your code to a new branch. Feel free to create an issue or make a pull request. +Any contributors who want to make this project better can make contributions, which will be greatly appreciated. To contribute, clone this repo locally and commit your code to a new branch. Feel free to create an issue or make a pull request. ## 📄 License -ezProfile is licensed under the [Apache-2.0 License](https://github.com/arifszn/ezprofile/blob/main/LICENSE). +ezProfile is licensed under the [Apache-2.0 License](https://github.com/arifszn/ezprofile/blob/main/LICENSE). \ No newline at end of file