Skip to content

Commit 7b27615

Browse files
Update README.md
1 parent c596615 commit 7b27615

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,48 @@
1010
</p>
1111

1212

13-
### TODO
13+
## What’s In This Document
1414

15-
I'm working on the documentation.
15+
- [About This Tool](#-about-this-tool)
16+
- [How to Setup Locally](#-how-to-setup-locally)
17+
- [How to Contribute](#-how-to-contribute)
18+
- [License](#license)
19+
20+
<br/>
21+
22+
## 📖 About This Tool
23+
24+
I was re-desiging my portfolio webiste and my main task that where I'll host my baisc data from where I can manage the content easy and simple. But there are no solution. So, I get the idea about GitHub API and using GitHub APIs I build this tool. So, my website(https://mohddanish.me) content is managed by this tool. So, I published this on ProductHunt(https://www.producthunt.com/posts/apis-with-github) and when people ask me that it's open souce? And then I say No. So, I quickly make this tool open Source. Because I love when people wants to contribute in your projects. check this thread (https://twitter.com/mddanishyusuf/status/1124261537537974278)
25+
26+
<br/>
27+
28+
## ✍ How to Setup Locally
29+
30+
This tool is build with React(CRA), GitHub APIs, JSON Editor(https://github.com/josdejong/jsoneditor) and Bootstrap for Grid System. And Hosted on Netlify.
31+
32+
## Steps
33+
34+
1. `git clone https://github.com/mddanishyusuf/json-apis-with-github`
35+
2. `cd json-apis-with-github`
36+
3. `yarn install`
37+
4. `npm run start`
38+
39+
<br/>
40+
41+
## 🤝 How to Contribute
42+
43+
So, Yes, you can add any feature that will help others. And Suggestion is also a contribution. If you have any comment So, you can leave your thought here. https://github.com/mddanishyusuf/json-apis-with-github/issues/1
44+
45+
<br/>
46+
47+
### Tool Build With
48+
49+
- **ReactJS**- Create React APP(https://github.com/facebook/create-react-app)
50+
- **GitHub APIs:** https://developer.github.com/v3/
51+
- **Netlify:** To host the tool.
52+
53+
<br/>
54+
55+
## License
56+
57+
[![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](https://creativecommons.org/publicdomain/zero/1.0/)

0 commit comments

Comments
 (0)