1
1
<br >
2
2
3
3
<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 >
7
7
</p >
8
8
9
9
<br >
10
10
11
11
### Usage
12
12
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 ) .
14
14
15
- Change the ` ?userID= ` value to your StackOverflow's userID.
15
+ This is the syntax:
16
16
17
17
``` md
18
- [](https://stackoverflow.com/users/6558042/omid-nikrah)
18
+ [](https://stackoverflow.com/users/6558042/omid-nikrah)
19
19
```
20
20
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 )
23
25
24
26
#### Compact Layout
25
27
26
28
If you want to have a compact layout, just you need to add ` layout=compact ` as a parameter. Check out the options.
27
29
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 )
30
32
31
33
32
34
<br >
@@ -35,6 +37,7 @@ If you want to have a compact layout, just you need to add `layout=compact` as a
35
37
| Name | Description | Default value |
36
38
| ---------- | ------------------------------- | -------------------------- |
37
39
| userID | Your StackOverflow userID | REQUIRED |
40
+ | site | Your StackOverflow userID | REQUIRED |
38
41
| theme | Theme of the StackOverflow card (light or dark) | light |
39
42
| layout | Layout of the StackOverflow card (compact or default) | default |
40
43
@@ -43,8 +46,11 @@ If you want to have a compact layout, just you need to add `layout=compact` as a
43
46
## Contributors
44
47
- [ Omid Nikrah] ( https://github.com/omidnikrah )
45
48
- [ Soroush Chehresa] ( https://github.com/soroushchehresa )
49
+ - [ Diego Borba] ( https://github.com/diegoborbadev )
46
50
47
51
<br >
48
52
53
+ <a name =" deploy-your-own " ></a >
54
+
49
55
## Deploy your own
50
56
[ ![ Deploy with Vercel] ( https://vercel.com/button )] ( https://vercel.com/import/git?s=https://github.com/diegoborbadev/github-readme-stack-exchange )
0 commit comments