diff --git a/README.md b/README.md index 6a0009d..77b9cb2 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,41 @@ -# github-graphs +# Github-Graphs + Website for visualizing a persons github network. +![Example Graph](./doc/graphExample.png) + +If you are lucky, you can find the site live +[here](https://github-graphs.com/); + # Built With + - [BootStrap](https://getbootstrap.com/) CSS Framework - [jQuery](https://jquery.com/) - [Vis JS](http://visjs.org/) -- [Github v3 API](https://developer.github.com/v3/) \ No newline at end of file +- [Github v3 API](https://developer.github.com/v3/) +- [Node.js](https://nodejs.org/en/) + + +![javascript](./doc/javaScript.jpg) + +# Running + +Update your conf.json file to contain your preferred port and github +api credentials. + +```bash +npm install +``` + +```bash +node server.js +``` + + +# Contributing + +If you want to contribute to this project and don't know where to start, +look at the open issues. Once you know what you want to work on, +just discuss it in the issues and file a pull request. We are very open +to new contributes. \ No newline at end of file diff --git a/doc/graphExample.png b/doc/graphExample.png new file mode 100644 index 0000000..1245354 Binary files /dev/null and b/doc/graphExample.png differ diff --git a/doc/javaScript.jpg b/doc/javaScript.jpg new file mode 100644 index 0000000..3db457e Binary files /dev/null and b/doc/javaScript.jpg differ