Skip to content

Commit

Permalink
docs: change the new url as per vercel deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
@shravan20
shravan20 committed Mar 21, 2024
1 parent a504229 commit 3007e25
Showing 1 changed file with 58 additions and 51 deletions.
109 changes: 58 additions & 51 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Your contributions and involvement in the project are welcome.
---

<p align="center">
<h1 align="center">
<h1 align="center">
Featuring on <a href="https://www.producthunt.com/posts/dynamic-github-profile-readme-quotes?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-dynamic-github-profile-readme-quotes" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=276934&theme=light" alt="Dynamic GitHub Profile Readme Quotes - Everlasting Poetic Touch to GitHub Profiles for everyone | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" align="center"/></a>
</h1>
</p>
Expand All @@ -45,13 +45,13 @@ Your contributions and involvement in the project are welcome.

<br>

### 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

<img src="./assets/uiScreen.gif" width=100% align="center"/>

---

## Features
## Features

| Sl No | Feature Name | Description |
|:-:|:-:|:-:|
Expand All @@ -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 |




---


<p align="center">
Note: To read an article on this project, please refer:
<a href = "https://dev.to/imshravan/github-profile-readme-animated-dynamic-quote-generator-4le6"><i>GitHub Profile README : Animated Dynamic Quote Generator</i></a>
</p>


---

# 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)
```
<!-- Scrnshot of quote in default mode -->
<p align="center">
Expand All @@ -90,26 +86,27 @@ Copy and paste the following markdown content to display the quote.
<br><hr>

- ### 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)
```
<!-- Scrnshot of quote in dark theme -->

#### 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?)

<!-- Scrnshot of quote in different themes -->

Expand All @@ -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)

<!-- Scrnshot of quote in particular layout -->

Expand All @@ -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)

<!-- Scrnshot of quote in different fonts -->

Expand All @@ -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)
```
<!-- Gif of quote in animation -->

#### 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)
<b>Feel free to contribute different quotes to different categories.</b>
#### 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).
---
- ##### <img src="https://user-images.githubusercontent.com/18126719/56791599-0868f980-683a-11e9-8a8b-134ced040c8e.png" width="30"> _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)
---
- ##### <img src="https://ghost.org/images/docs/setup/fork.gif" width="30"> _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)
<div>
<h5><img src="https://user-images.githubusercontent.com/18126719/56791599-0868f980-683a-11e9-8a8b-134ced040c8e.png" width="30"> <em>Huge Shoutout to all the Star-Gazers</em></h5>
<a href="https://github.com/shravan20/github-readme-quotes/stargazers">
<img src="https://bytecrank.com/nastyox/reporoster/php/stargazersSVG.php?user=shravan20&repo=github-readme-quotes" alt="Stargazers repo roster for @shravan20/github-readme-quotes">
</a>
</div>
<hr>
<div>
<h5><img src="https://ghost.org/images/docs/setup/fork.gif" width="30"> <em>Huge Shoutout to all the Forkers</em></h5>
<a href="https://github.com/shravan20/github-readme-quotes/network/members">
<img src="https://bytecrank.com/nastyox/reporoster/php/forkersSVG.php?user=shravan20&repo=github-readme-quotes" alt="Forkers repo roster for @shravan20/github-readme-quotes">
</a>
</div>

0 comments on commit 3007e25

Please sign in to comment.