diff --git a/README.md b/README.md index 34b6100..092e84f 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Your contributions and involvement in the project are welcome. ---

-

+

Featuring on Dynamic GitHub Profile Readme Quotes - Everlasting Poetic Touch to GitHub Profiles for everyone | Product Hunt

@@ -45,13 +45,13 @@ Your contributions and involvement in the project are welcome.
-### Use [User Interface](https://github-readme-quotes.herokuapp.com/), to view designed quotes and copy link and paste it directly +### Use [User Interface](https://https://github-readme-quotes-bay.vercel.app/), to view designed quotes and copy link and paste it directly --- -## Features +## Features | Sl No | Feature Name | Description | |:-:|:-:|:-:| @@ -62,25 +62,21 @@ Your contributions and involvement in the project are welcome. | 5 | [Custom Quotes from GitHub Gists](#custom-quotes) | You can add custom quotes of your own or own choice from GitHub Gists json files | | 6 | [Quotes based on Category](#category-based-quotes) | Different category based quotes are available | - - - --- -

Note: To read an article on this project, please refer: GitHub Profile README : Animated Dynamic Quote Generator

- --- # Github Readme Quotes + Copy and paste the following markdown content to display the quote. ```md -![Quote](https://github-readme-quotes.herokuapp.com/quote) +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote) ```

@@ -90,26 +86,27 @@ Copy and paste the following markdown content to display the quote.


- ### Themes + You can display your quote in different themes without any manual customization. Use `?theme=THEME_NAME` parameter as shown below. - ```md -![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark) +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?theme=dark) ``` #### Available Themes + dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula **Dark** -![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark) +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?theme=dark) **Light Theme** -![Quote](https://github-readme-quotes.herokuapp.com/quote?) +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?) @@ -120,21 +117,22 @@ You can explore different themes [here](./src/themes/README.md). --- - ### Layouts + You can also change the layout of your templates. Use `?layout=LAYOUT` parameter as shown below - ```md -![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&layout=socrates) +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?theme=dark&layout=socrates) ``` + #### Layout 1 (Default) -![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark) +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?theme=dark) #### Layout 2 (Socrates) -![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&layout=socrates) +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?theme=dark&layout=socrates) @@ -145,21 +143,22 @@ You can explore different layouts [here](./src/layouts/README.md). --- - ### Fonts + You can also add fonts to your templates. Use `?font=FONT_NAME` parameter as shown below ```md -![Quote](https://github-readme-quotes.herokuapp.com/quote?font=Redressed) +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?font=Redressed) ``` #### Font 1 (Default) -![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark) +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?theme=dark) #### Font 2 (Redressed) -![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&font=Redressed) +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?theme=dark&font=Redressed) @@ -170,83 +169,91 @@ You can explore different fonts [here](./src/fonts/README.md). --- - ### Animations + You can also add animations to your templates. Use `?animation=ANIMATION` paramater as shown below ```md -![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&animation=grow_out_in) +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?theme=dark&animation=grow_out_in) ``` #### Animation 1 -![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&animation=grow_out_in) - +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?theme=dark&animation=grow_out_in) You can explore different animations [here](./src/animations/README.md). - --- - ### Custom Quotes + You can also provide a file with the list of quotes and a random quote will be generated for you. -#### Follow the steps to provide your own custom quotes, +#### Follow the steps to provide your own custom quotes + - Use the template provided at [here](./customQuotes/quotes.json) and write your own file with multiple quotes. - Save the file in the repository in any (public) directory or anywhere in the internet. - Get the link of the file. - Use `?quotesUrl=URL` as shown below + ``` - ![Quote](https://github-readme-quotes.herokuapp.com/quote?quotesUrl=https://github.com/ShubhKotnala/github-readme-quotes/blob/custom-quotes/customQuotes/quotes.json) + ![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?quotesUrl=https://github.com/ShubhKotnala/github-readme-quotes/blob/custom-quotes/customQuotes/quotes.json) ``` -![Quote](https://github-readme-quotes.herokuapp.com/quote?quotesUrl=https://github.com/ShubhKotnala/github-readme-quotes/blob/custom-quotes/customQuotes/quotes.json) - +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?quotesUrl=https://github.com/ShubhKotnala/github-readme-quotes/blob/custom-quotes/customQuotes/quotes.json) --- - ### Category based Quotes + You can also provide a category to fetch the list of quotes based on certain category and a random quote will be generated for you based on category you specify. #### Available Categories - - motivational - - fun - - life - - general - - programming - - success..etc. - - - Use `quoteCategory=categoryName` as shown below - ``` - ![Quote](https://github-readme-quotes.herokuapp.com/quote?quoteCategory=motivational) - ``` +- motivational +- fun +- life +- general +- programming +- success..etc. -![Quote](https://github-readme-quotes.herokuapp.com/quote?quoteCategory=motivational) + - Use `quoteCategory=categoryName` as shown below + + ``` + ![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?quoteCategory=motivational) + ``` +![Quote](https://https://github-readme-quotes-bay.vercel.app/quote?quoteCategory=motivational) Feel free to contribute different quotes to different categories. -#### Follow the steps to add quotes to category, +#### Follow the steps to add quotes to category + - Add the quote you want in this [file](./customQuotes/category.json) based on the category it falls into. - If the category you want doesn't exist, feel free to add the category in this [file](./customQuotes/category.json) and add the quotes. - - --- ## Swagger Docs To view Swagger docs, run `npm start` and open ![localhost:3002/api-docs](localhost:3002/api-docs). - ---- - -- ##### _Huge Shoutout to all the Star-Gazers_ -[![Stargazers repo roster for @shravan20/github-readme-quotes](https://reporoster.com/stars/shravan20/github-readme-quotes)](https://github.com/shravan20/github-readme-quotes/stargazers) - --- -- ##### _Huge Shoutout to all the Forkers_ -[![Forkers repo roster for @shravan20/github-readme-quotes](https://reporoster.com/forks/shravan20/github-readme-quotes)](https://github.com/shravan20/github-readme-quotes/network/members) +
+
Huge Shoutout to all the Star-Gazers
+ + Stargazers repo roster for @shravan20/github-readme-quotes + +
+ +
+ +
+
Huge Shoutout to all the Forkers
+ + Forkers repo roster for @shravan20/github-readme-quotes + +