Skip to content

Commit 7f56591

Browse files
committed
README updated
1 parent eb76d97 commit 7f56591

File tree

3 files changed

+17
-11
lines changed

3 files changed

+17
-11
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,34 @@
11
<br>
22

33
<p align="center">
4-
<img width="120px" src="https://raw.githubusercontent.com/omidnikrah/github-readme-stackoverflow/master/stackoverflow.svg" />
5-
<h2 align="center">GitHub Readme StackOverflow</h2>
6-
<p align="center">Show your StackOverflow profile status on your READMEs!</p>
4+
<img width="120px" src="stackexchange.svg" />
5+
<h2 align="center">GitHub Readme Stack Exchange</h2>
6+
<p align="center">Show your status for any Stack Exchange site on your READMEs!</p>
77
</p>
88

99
<br>
1010

1111
### Usage
1212

13-
Copy paste following markdown into your markdown content, and that's it. Easy Easy Tammam Tammam!
13+
You can use the instance that already exists, but **it's highly recommended** to [deploy on your own](#deploy-your-own).
1414

15-
Change the `?userID=` value to your StackOverflow's userID.
15+
This is the syntax:
1616

1717
```md
18-
[![Omid Nikrah StackOverflow](https://github-readme-stackoverflow.vercel.app/?userID=6558042)](https://stackoverflow.com/users/6558042/omid-nikrah)
18+
[![Omid Nikrah StackOverflow](https://github-readme-stack-exchange.vercel.app/?userID=6558042&site=stackoverflow)](https://stackoverflow.com/users/6558042/omid-nikrah)
1919
```
2020

21-
[![Omid Nikrah StackOverflow](https://github-readme-stackoverflow.vercel.app/?userID=6558042)](https://stackoverflow.com/users/6558042/omid-nikrah)
22-
[![Omid Nikrah StackOverflow](https://github-readme-stackoverflow.vercel.app/?userID=6558042&theme=dark)](https://stackoverflow.com/users/6558042/omid-nikrah)
21+
Change the `userID` value to your userID, and the `site` to any [*Stack Exchange site*](https://stackexchange.com/sites) that you want.
22+
23+
[![Omid Nikrah StackOverflow](https://github-readme-stack-exchange.vercel.app/?userID=6558042&site=stackoverflow)](https://stackoverflow.com/users/6558042/omid-nikrah)
24+
[![Diego Borba StackOverflow](https://github-readme-stack-exchange.vercel.app/?userID=21144042&site=stackoverflow&theme=dark)](https://stackoverflow.com/users/21144042/diego-borba)
2325

2426
#### Compact Layout
2527

2628
If you want to have a compact layout, just you need to add `layout=compact` as a parameter. Check out the options.
2729

28-
[![Omid Nikrah StackOverflow](https://github-readme-stackoverflow.vercel.app/?userID=6558042&layout=compact)](https://stackoverflow.com/users/6558042/omid-nikrah)
29-
[![Omid Nikrah StackOverflow](https://github-readme-stackoverflow.vercel.app/?userID=6558042&layout=compact&theme=dark)](https://stackoverflow.com/users/6558042/omid-nikrah)
30+
[![Omid Nikrah StackOverflow](https://github-readme-stack-exchange.vercel.app/?userID=6558042&site=stackoverflow&layout=compact)](https://stackoverflow.com/users/6558042/omid-nikrah)
31+
[![Diego Borba StackOverflow](https://github-readme-stack-exchange.vercel.app/?userID=21144042&site=stackoverflow&layout=compact&theme=dark)](https://stackoverflow.com/users/21144042/diego-borba)
3032

3133

3234
<br>
@@ -35,6 +37,7 @@ If you want to have a compact layout, just you need to add `layout=compact` as a
3537
| Name | Description | Default value |
3638
| ---------- | ------------------------------- | -------------------------- |
3739
| userID | Your StackOverflow userID | REQUIRED |
40+
| site | Your StackOverflow userID | REQUIRED |
3841
| theme | Theme of the StackOverflow card (light or dark) | light |
3942
| layout | Layout of the StackOverflow card (compact or default) | default |
4043

@@ -43,8 +46,11 @@ If you want to have a compact layout, just you need to add `layout=compact` as a
4346
## Contributors
4447
- [Omid Nikrah](https://github.com/omidnikrah)
4548
- [Soroush Chehresa](https://github.com/soroushchehresa)
49+
- [Diego Borba](https://github.com/diegoborbadev)
4650

4751
<br>
4852

53+
<a name="deploy-your-own"></a>
54+
4955
## Deploy your own
5056
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/git?s=https://github.com/diegoborbadev/github-readme-stack-exchange)

stackexchange.svg

Lines changed: 1 addition & 0 deletions
Loading

stackoverflow.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)