Merge pull request #192 from runelite-extended/Kyleeld-readme

Kyleeld readme

.github/CONTRIBUTING.md

@@ -14,7 +14,7 @@ Here are the guidelines we'd like you to follow:
 
 ## <a name="question"></a> Got a Question or Problem?
 
-If you have questions about how to contribute to runelite, please join our [Discord](https://discord.gg/mePCs8U) server.
+If you have questions about how to contribute to runelite, please join our [Discord](https://discord.gg/HN5gf3m) server.
 
 ## <a name="issue"></a> Found an Issue?
 
@@ -43,7 +43,7 @@ quickly:
 ### Submitting a Pull Request
 Before you submit your pull request consider the following guidelines:
 
-* Search [GitHub](https://github.com/runelite/runelite/pulls) for an open or closed Pull Request
+* Search [GitHub](https://github.com/runelite-extended/runelite/pulls) for an open or closed Pull Request
   that relates to your submission. You don't want to duplicate effort.
 * [Fork](https://help.github.com/articles/fork-a-repo/) this repo.
 * [Clone](https://help.github.com/articles/cloning-a-repository/) your copy.
@@ -54,7 +54,7 @@ Before you submit your pull request consider the following guidelines:
 * After cloning, set a new remote [upstream](https://help.github.com/articles/configuring-a-remote-for-a-fork/) (this helps to keep your fork up to date)
     
     ```shell
-    git remote add upstream https://github.com/runelite/runelite.git
+    git remote add upstream https://github.com/runelite-extended/runelite.git
     ```
 
 * Make your changes in a new git branch:
@@ -130,5 +130,5 @@ from the main (upstream) repository:
 To ensure consistency throughout the source code, review our [code conventions](https://github.com/runelite/runelite/wiki/Code-Conventions).
 
 
-[github]: https://github.com/runelite/runelite
-[discord]: https://discord.gg/mePCs8U
+[github]: https://github.com/runelite-extended/runelite
+[discord]: https://discord.gg/HN5gf3m

README.md

@@ -1,4 +1,25 @@
 ![](https://i.imgur.com/OVRdQBz.png)
 
-[![Discord](https://img.shields.io/discord/373382904769675265.svg)](https://discord.gg/HN5gf3m) [![Build Status](https://travis-ci.org/runelite-extended/runelite.svg?branch=master)](https://travis-ci.org/runelite-extended/runelite)  
+
+
+# RuneLitePlus [![Build Status](https://travis-ci.org/runelite-extended/runelite.svg?branch=master)](https://travis-ci.org/runelite-extended/runelite) [![Discord](https://img.shields.io/discord/373382904769675265.svg)](https://discord.gg/HN5gf3m)
+
 [RuneLitePlus](https://runelitepl.us)  is a fork of [RuneLite](https://github.com/runelite/runelite) that provides more functionality and less restrictions while staying open source. This is meant to directly compete with 3rd party RL clients that are trying to sell their code.
+
+## Project Layout
+
+- [cache](cache/src/main/java/net/runelite/cache) - Libraries used for reading/writing cache files, as well as the data in it
+- [http-api](http-api/src/main/java/net/runelite/http/api) - API for api.runelite.net
+- [http-service](http-service/src/main/java/net/runelite/http/service) - Service for api.runelite.net
+- [runelite-api](runelite-api/src/main/java/net/runelite/api) - RuneLite API, interfaces for accessing the client
+- [runelite-mixins](runelite-mixins/src/main/java/net/runelite) - Mixins which are injected into the injected client's classes
+- [runescape-api](runescape-api/src/main/java/net/runelite) - Mappings correspond to these interfaces, runelite-api is a subset of this
+- [runelite-client](runelite-client/src/main/java/net/runelite/client) - Game client with plugins
+
+## License
+
+RuneLitePlus is licensed under the BSD 2-clause license. See the license header in the respective file to be sure.
+
+## Contribute and Develop
+
+We've set up a separate document for our [contribution guidelines](https://github.com/runelite-extended/runelite/blob/master/.github/CONTRIBUTING.md).