diff options
| author | Daniel Lublin <daniel@lublin.se> | 2020-03-30 23:13:45 +0300 |
|---|---|---|
| committer | Daniel Lublin <daniel@lublin.se> | 2020-03-30 23:13:45 +0300 |
| commit | e8f45ae5e804b9905322cdda4be942d25ede1a6a (patch) | |
| tree | 74059547fdc546fc74820ed52f757981ca3177a1 | |
| parent | 097bc43754a7d1fb1ef72071ae121225eef66157 (diff) | |
Update README
| -rw-r--r-- | README.md | 43 |
1 files changed, 22 insertions, 21 deletions
@@ -1,30 +1,31 @@ -Jumble -====== +# Humla -An Android service implementation of the Mumble protocol, designed as the backend of [Plumble](https://www.github.com/acomminos/Plumble). +Humla is a fork of [Jumble](https://github.com/acomminos/Jumble), an Android +service implementation of the Mumble protocol which was originally written by +Andrew Comminos as the backend of [Plumble](https://github.com/acomminos/Plumble). +Humla is the backend of [Mumla](https://gitlab.com/quite/mumla). -About ------ +## About Jumble -The primary goal of the Jumble project is to encourage developers to embrace the Mumble protocol on Android through a free, complete, and stable implementation. At the moment, development is focused on improving stability and security. +The primary goal of the Jumble project is to encourage developers to embrace +the Mumble protocol on Android through a free, complete, and stable +implementation. At the moment, development is focused on improving stability +and security. -Prior to the release of Jumble, all implementations of the Mumble protocol on Android have been using the same non-free code developed by @pcgod. To ensure the unencumbered use of Jumble, no sources or derivatives will be copied from that project. +Prior to the release of Jumble, all implementations of the Mumble protocol on +Android have been using the same non-free code developed by @pcgod. To ensure +the unencumbered use of Jumble, no sources or derivatives will be copied from +that project. -Projects using Jumble ---------------------- +## Including in your project -[Plumble 3.0+](https://www.github.com/acomminos/Plumble) +Humla is a standard Android library project using the gradle build system. +[See here for instructions on how to include it into your gradle project](http://tools.android.com/tech-docs/new-build-system/user-guide#TOC-Referencing-a-Library). -Including in your project -------------------------- +Currently, there is no tutorial to integrate Humla with your project. In the +mean time, please examine the exposed interface IHumlaService as well as +Mumla's implementation. -Jumble is a standard Android library project using the gradle build system. [See here for instructions on how to include it into your gradle project](http://tools.android.com/tech-docs/new-build-system/user-guide#TOC-Referencing-a-Library). +## License -Currently, there is no tutorial to integrate Jumble with your project. In the mean time, please examine the exposed interface IJumbleService as well as Plumble's implementation. - -License -------- - -Jumble is now licensed under the GNU GPL v3+. See LICENSE. - -If you wish to incorporate Jumble into your proprietary project, please email me to discuss licensing. +Humla is now licensed under the GNU GPL v3+. See [LICENSE](LICENSE). |