From 34c9f5da91862d6fa62747812fbbe652ba71c4ab Mon Sep 17 00:00:00 2001 From: Ziver Koc Date: Wed, 28 Sep 2016 15:09:49 +0200 Subject: [PATCH] Updated README file --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5a86071..5f099fe 100755 --- a/README.md +++ b/README.md @@ -1,10 +1,17 @@ # Hal -This project is a collection of utility classes and methods that I use in most of my projects. -Some of the code is incomplete and might never be completed (If no one is requesting otherwise :D). +This project is a collection of utility classes and methods that I use in most +of my projects. Some of the code is incomplete and might never be completed +(If no one is requesting otherwise :D). -**A word of warning:** This project is mostly used as a sandbox to implement APIs and functions I think are interesting. So there are no guaranties that Classes and methods will stay as they are, I'm often refactoring the code and moving things around. +**A word of warning:** This project is mostly used as a sandbox to implement +APIs and functions I think are interesting. So there are no guaranties that +classes and methods will stay as they are, I'm often refactoring the code and +moving things around. +## Documentation +Unfortunately, there is no dedicated documentation available. The only documentation +is the JavaDoc in the source code and see the JUnit test cases for usage examples. ## Running the tests @@ -20,5 +27,6 @@ ant test ## License -This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details +This project is licensed under the MIT License - +see the [LICENSE.txt](LICENSE.txt) file for details