Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
willjrowe committed Aug 31, 2020
1 parent efff702 commit 905097c
Showing 1 changed file with 44 additions and 2 deletions.
46 changes: 44 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,44 @@
# github-readme-fortnite
Dynamically generate your Fortnite stats on your GitHub READMEs!
<p align="center">
<img src="./fortnite.png" alt="Fortnite" />
<h2 align="center">GitHub README Fortnite</h2>
<p align="center">Show off your Fortnite stats on your READMEs!</p>
</p>

### Live Example

<img src="https://github-readme-fortnite.vercel.app/?username=FlipperTrain957" alt="My Fortnite Stats" align="left" />

<br />
<br />
<br />
<br />
<br />

### How To

Copy and paste the following img tag into your Markdown file.

Replace `YOURUSERNAMEHERE` with your username.

```md
<img src="https://github-readme-fortnite.vercel.app/?username=YOURUSERNAMEHERE" alt="My Fortnite Stats" align="left" />
```

If you don't know your Epic account username, you can use your Xbox Live or Playstation Network username by adding `&platform=YOURPLATFORM` to the end of the query string.
For Xbox use xbl and for Playstation use psn.

Example:

```md
<img src="https://github-readme-fortnite.vercel.app/?username=YOURUSERNAMEHERE&platform=xbl" alt="My Fortnite Stats" align="left" />
```

### Acknowledgments

The Fortnite API is provided by [FortniteAPI](https://fortniteapi.io/)

Inspired by [this incredible resource](https://github.com/abhisheknaiidu/awesome-github-profile-readme)

### Using your own Vercel project

Coming soon!

1 comment on commit 905097c

@vercel
Copy link

@vercel vercel bot commented on 905097c Aug 31, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.