From 58af6a9f39ba41a924c1852a11db4613ad500b19 Mon Sep 17 00:00:00 2001 From: TacoTheDank Date: Fri, 10 Jul 2020 15:56:02 -0400 Subject: [PATCH] Clean up and update README.md --- README.md | 133 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 83 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 5309aa4a..c16aef7c 100644 --- a/README.md +++ b/README.md @@ -1,89 +1,122 @@ Transdroid ========== -[www.transdroid.org](http://www.transdroid.org) +[www.transdroid.org](https://www.transdroid.org/) [Twitter](https://twitter.com/transdroid) - [transdroid@2312.nl](transdroid@2312.nl) -"Manage your torrents from your Android device" - - -Get it on transdroid.org - -Get it on F-Droid - -Get it on Google Play - -Screen shot of the main torrents listing screen - - -Manage your torrents from your Android device with Transdroid. All popular clients are supported: µTorrent, Transmission, rTorrent, Vuze, Deluge, BitTorrent 6, qBittorrent and many more. You can view and manage the running torrents and individual files. Adding is easy via the integrated search or RSS feeds (full version required). Monitor progress using the home screen widget or background alarm service. +Manage torrents from your Android device. + + + Get it on transdroid.org + + + Get it on F-Droid + + + Get it on Google Play + + +Screen shot of the main torrents listing screen + + +Manage your torrents from your Android device with Transdroid. +All popular clients are supported: µTorrent, Transmission, rTorrent, Vuze, Deluge, BitTorrent 6, qBittorrent, and many more. +You can view and manage running torrents and individual files. +Adding is easy via the integrated search or RSS feeds (full version required). +Monitor progress using the home screen widget or background alarm service. Contributions ============= -Code and design contributions are very welcome. You might want to contact me via social networks (G+, Twitter) or e-mail first. Please note all code will be GNU GPL v3 licensed. +Code and design contributions are very welcome. +You might want to contact me via social networks (Twitter) or e-mail first. +Please note that all code will be licensed in GNU GPLv3. -Please respect the coding standards for easier merging. master contains the current release version of Transdroid while dev contains the active development version. However, larger, new features are developed in their own branch. +Please respect the coding standards for easier merging. +`master` contains the current release version of Transdroid while `dev` contains the active development version. +However, larger and new features will be developed in their own branch. Code structure ============== -Starting with version 2.3.0, Transdroid is developed in Android Studio, fully integrating with the Gradle build system. It is (since version 2.5.0) compiled against Android 5.1 (API level 22) and (since version 2.2.0) supporting ICS (API level 15) and up only. To support lite (Transdrone, specially for the Play Store) and full (Transdroid) versions of the app, build flavours are defined in gradle, which contain version-specific resources. Dependencies are managed via JCentral et al. in the app's build.gradle file. +Starting with version 2.3.0, Transdroid is developed in Android Studio, fully integrating with the Gradle build system. +It is (since version 2.5.18) compiled against Android 10 (API level 29) and (since version 2.2.0) supporting Android ICS (API level 15) and up only. +To support lite (Transdrone, specially for the Play Store) and full (Transdroid) versions of the app, build flavours are defined in gradle, which contain version-specific resources. +Dependencies are managed via JCentral et al. in the app's build.gradle file. Developed By ============ -Designed and developed by [Eric Kok](eric@2312.nl) of [2312 development](http://2312.nl). Contributions by various others (see commit log). +Designed and developed by [Eric Kok](eric@2312.nl) of [2312 development](https://2312.nl/). +Contributions by various others (see commit log). License ======= - - Copyright 2010-2018 Eric Kok et al. - + + Copyright 2010-2020 Eric Kok et al. + Transdroid is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - + Transdroid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - + You should have received a copy of the GNU General Public License - along with Transdroid. If not, see . - -Some code/libraries/resources are used in the project: + along with Transdroid. If not, see . -* [AndroidAnnotations](http://androidannotations.org/) - Pierre-Yves Ricau (eBusinessInformations) et al. +Some code/libraries/resources are used in the project: +* [Android Jetpack (AndroidX)](https://developer.android.com/jetpack) + The Android Open Source Project Apache License, Version 2.0 -* [ActionBar-PullToRefresh](https://github.com/chrisbanes/ActionBar-PullToRefresh) - Chris Banes +* [AndroidAnnotations](http://androidannotations.org/) + Pierre-Yves Ricau (eBusinessInformations) et al. Apache License, Version 2.0 -* [Crouton](https://github.com/keyboardsurfer/Crouton) - Code: Benjamin Weiss (Neofonie Mobile Gmbh) et al. - Idea: Cyril Mottier +* [ORMLite](https://github.com/j256/ormlite-core) and [ORMLite Android](https://github.com/j256/ormlite-android) + Gray Watson + ISC License +* [Android Universal Image Loader](https://github.com/nostra13/Android-Universal-Image-Loader) + Sergey Tarasevich Apache License, Version 2.0 -* [Base16Encoder](http://openjpa.apache.org/) - Marc Prud'hommeaux - Apache OpenJPA -* MultipartEntity - Apache Software Foundation +* [FloatingActionButton](https://github.com/zendesk/android-floating-action-button) + Oleksandr Melnykov, Zendesk Apache License, Version 2.0 -* RssParser ([learning-android](http://github.com/digitalspaghetti/learning-android)) - Tane Piper - Public Domain -* [Base64](http://iharder.net/base64) - Robert Harder +* [Snackbar](https://github.com/nispok/snackbar) + William Mora + MIT License +* [Java implementation of Rencode](https://github.com/aegnor/rencode-java) + Daniel Dimovski + MIT License +* [OpenJPA's Base16Encoder](https://github.com/apache/openjpa) + Marc Prud'hommeaux + Apache OpenJPA +* [Base64](http://iharder.sourceforge.net/current/java/base64/) + Robert Harder Public Domain -* [aXMLRPC](https://github.com/timroes/aXMLRPC) - Tim Roes +* [aXMLRPC](https://github.com/gturri/aXMLRPC) + Tim Roes MIT License -* [android-ColorPickerPreference](https://github.com/attenzione/android-ColorPickerPreference) - Daniel Nilsson and Sergey Margaritov +* [Material Dialogs](https://github.com/afollestad/material-dialogs) + Aidan Follestad Apache License, Version 2.0 -* [Funnel icon](http://thenounproject.com/noun/funnel/#icon-No5608) - Naomi Atkinson from The Noun Project +* [Android-Job](https://github.com/evernote/android-job) + Evernote Corporation + Apache License, Version 2.0 +* [android-ColorPickerPreference](https://github.com/attenzione/android-ColorPickerPreference) + Daniel Nilsson and Sergey Margaritov + Apache License, Version 2.0 +* RssParser ([learning-android](https://github.com/tanepiper/learning-android)) + Tane Piper + Public Domain +* [Funnel icon](https://thenounproject.com/term/funnel/5608/) + Naomi Atkinson from The Noun Project Creative Commons Attribution 3.0 -