From 5446bb1605e2b8bf43498efe3ce8051d316d8a61 Mon Sep 17 00:00:00 2001 From: twemyeez Date: Mon, 27 Oct 2014 09:48:17 +0000 Subject: [PATCH 1/2] Add a template readme --- README.md | 41 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0943bc10..785d2587 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,41 @@ -TODO:
+Hypixel Public API (Java) +====== + +This is a Java implementation of the Hypixel API + +Dependencies +--------------------------- + +The Hypixel PublicAPI has the following dependencies: +- GSON +- Google Collections Libary + + +Documentation +------------- + +Hypixel PublicAPI documentation is mostly contained within the source code and the [example code](https://github.com/HypixelDev/PublicAPI/tree/master/Example/src/main/java/net/hypixel/example) + +API Information +--- + +The Hypixel PublicAPI has a request limit of 60 queries per minute. + + +Bug Reporting +------------- + +You can post reports on the modification thread, or you can create an issue here on GitHub. + + +Copyright +------- + +HypixelAPI (c) 2014 + + +TODO +----- * Add a proper readme
* Add a proper copyright header to all files
* Deploy to a public maven repo
- -HypixelAPI (C) 2014 From e49a26e5da836cd6641d63c79a0e2f09024d79ab Mon Sep 17 00:00:00 2001 From: twemyeez Date: Mon, 27 Oct 2014 09:48:34 +0000 Subject: [PATCH 2/2] Fix readme typo --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 785d2587..ca5a97db 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,16 @@ API Information The Hypixel PublicAPI has a request limit of 60 queries per minute. +API Authentication +--------------- + +Users can obtain API keys via doing /api when they log in. This key *must* be kept secret: any abuse can lead to API access being rescinded. + Bug Reporting ------------- -You can post reports on the modification thread, or you can create an issue here on GitHub. +You can create an issue here on GitHub to report a bug with the API or to suggest enhancements. Copyright @@ -36,6 +41,5 @@ HypixelAPI (c) 2014 TODO ----- -* Add a proper readme
-* Add a proper copyright header to all files
+* Add a proper copyright header to all files * Deploy to a public maven repo