mirror of
https://github.com/gsantner/dandelion
synced 2025-09-09 02:09:41 +02:00
Update Readme
This commit is contained in:
Gregor Santner
parent
ea7ceacc12
commit
e9fa2082d9
6 changed files with 128 additions and 76 deletions
89
README.md
89
README.md
|
|
@ -1,47 +1,84 @@
|
|||
[](https://f-droid.org/repository/browse/?fdid=com.github.dfa.diaspora_android)
|
||||
|
||||
<a name="badgers"></a>[](https://circleci.com/gh/Diaspora-for-Android/dandelion)
|
||||
[](https://github.com/diaspora-for-android/dandelion/releases)
|
||||
[](https://gsantner.github.io/#donate)
|
||||
[](https://circleci.com/gh/Diaspora-for-Android/dandelion)
|
||||
[](https://crowdin.com/project/diaspora-for-android)
|
||||
[](https://matrix.to/#/#dandelion:matrix.org) [](https://kiwiirc.com/client/irc.freenode.net/?nick=dandelion-anon|?##dandelion)
|
||||
|
||||
|
||||
|
||||
# dandelion\*
|
||||
<img src="/app/src/main/ic_launcher-web.png" align="left" width="100" hspace="10" vspace="10">
|
||||
This is an unofficial webview based client for the community-run, distributed social network <b><a href="https://diasporafoundation.org/">diaspora*</a></b>.
|
||||
|
||||
This is an unofficial webview based client for the community-run, distributed social network **[diaspora*](https://diasporafoundation.org/)**. It's currently under development and should be used with that in mind. Please submit any bugs you might find.
|
||||
<div style="display:flex;" >
|
||||
<a href="https://f-droid.org/repository/browse/?fdid=com.github.dfa.diaspora_android">
|
||||
<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="80">
|
||||
</a>
|
||||
<a href="https://play.google.com/store/apps/details?id=com.github.dfa.diaspora_android">
|
||||
<img alt="Get it on Google Play" height="80" src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" />
|
||||
</a>
|
||||
</div></br>
|
||||
|
||||
- Download latest release on ([F-Droid](https://f-droid.org/repository/browse/?fdid=com.github.dfa.diaspora_android))
|
||||
- Download latest nightly - [secondlion\*](https://gsantner.gitlab.io/fdroid/latest/com.github.dfa.secondlion.apk)
|
||||
- Watch [Changelog](https://github.com/Diaspora-for-Android/dandelion/blob/master/CHANGELOG.md)
|
||||
- See [Screenshots](https://github.com/Diaspora-for-Android/dandelion/blob/master/SCREENSHOTS.md)
|
||||
- Get updates from our diaspora\* account: [dandelion00@diasp.org](https://diasp.org/people/48b78420923501341ef3782bcb452bd5)
|
||||
|
||||
## Contributions
|
||||
We are always open for any kind of contribution. (PR's, bug reports, feature requests, translations, ..)
|
||||
If you got any questions feel free to contact us on IRC, XMPP or Gitter. You can start chatting by clicking on the [blue chat badges](#badgers) listed on top.
|
||||
## Description
|
||||
This is an unofficial webview based client for the community-run, distributed social network <b><a href="https://diasporafoundation.org/">diaspora*</a></b>.
|
||||
It's currently under development and should be used with that in mind. Please submit any bugs you might find.
|
||||
|
||||
We use Crowdin to translate dandelion\*. Join our project here: <https://crowdin.com/project/diaspora-for-android/invite>. If your desired language is not listed please contact the maintainers/owner.
|
||||
|
||||
Note that the main project members are working on this project for free during leisure time, are mostly busy with their job/university/school, and may not react or start coding immediately.
|
||||
|
||||
### License
|
||||
dandelion\* is released under GNU GENERAL PUBLIC LICENSE (see [LICENCE](https://github.com/Diaspora-for-Android/dandelion/blob/master/LICENSE.md)).
|
||||
The translations (strings.xml) are licensed CC0 1.0.
|
||||
|
||||
### WebApp
|
||||
#### WebApp
|
||||
The app is developed as a WebApp because currently diaspora\* doesn't have an functional API that can be used to create a native interface to retrieve the user's data, publications, direct messages and so on. That's why there are currently only WebApps for diaspora\* out there.
|
||||
[Stay tuned on diaspora\* issues](https://github.com/diaspora/diaspora/labels/api) about API.
|
||||
|
||||
Why is a WebApp better than using the mobile site on a browser?
|
||||
Basically it provides better integration with the system (events coming into and going out of the app), notifications, customized interface and functions and a nice little icon that takes you directly to your favorite social network :)
|
||||
|
||||
### Device Requirements
|
||||
#### Device Requirements
|
||||
The minimum Android version supported is Jelly Bean, Android v4.2.0 / API 17
|
||||
|
||||
### App Permissions
|
||||
### Privacy & Permissions<a name="privacy"></a>
|
||||
dandelion\* requires access to the Internet and to external storage to be able to upload photos when creating a new post and for taking screenshots.
|
||||
|
||||
## Maintainers
|
||||
|
||||
## Contributions
|
||||
The project is always open for contributions and accepts pull requests.
|
||||
The project uses [AOSP Java Code Style](https://source.android.com/source/code-style#follow-field-naming-conventions), with one exception: private members are `_camelCase` instead of `mBigCamel`. You may use Android Studios _auto reformat feature_ before sending a PR.
|
||||
|
||||
We use Crowdin to translate dandelion\*. Join our project here: <https://crowdin.com/project/diaspora-for-android/invite>. If your desired language is not listed please contact the maintainers/owner.
|
||||
|
||||
Join our IRC or Matrix channel (bridged) and say hello! Don't be afraid to start talking. [](https://matrix.to/#/#dandelion:matrix.org) [](https://kiwiirc.com/client/irc.freenode.net/?nick=dandelion-anon|?##dandelion)
|
||||
|
||||
Note that the main project members are working on this project for free during leisure time, are mostly busy with their job/university/school, and may not react or start coding immediately.
|
||||
|
||||
|
||||
#### Resources
|
||||
* Project: [Changelog](/CHANGELOG.md) | [Issues level/beginner](https://github.com/diaspora-for-android/dandelion/issues?q=is%3Aissue+is%3Aopen+label%3Alevel%2Fbeginner) | [License](/LICENSE.txt) | [CoC](/CODE_OF_CONDUCT.md)
|
||||
* Project diaspora\* account: [dandelion00@diasp.org](https://diasp.org/people/48b78420923501341ef3782bcb452bd5)
|
||||
* diaspora\*: [GitHub](https://github.com/diaspora/diaspora) | [Web](https://diasporafoundation.org) | [d\* HQ account](https://pod.diaspora.software/people/7bca7c80311b01332d046c626dd55703)
|
||||
* App on F-Droid: [Metadata](https://gitlab.com/fdroid/fdroiddata/blob/master/metadata/com.github.dfa.diaspora_android.txt) | [Page](https://f-droid.org/packages/com.github.dfa.diaspora_android/) | [Wiki](https://f-droid.org/wiki/page/com.github.dfa.diaspora_android) | [Build log](https://f-droid.org/wiki/page/com.github.dfa.diaspora_android/lastbuild)
|
||||
|
||||
|
||||
## Licensing
|
||||
dandelion\* is released under GNU GENERAL PUBLIC LICENSE (see [LICENCE](https://github.com/Diaspora-for-Android/dandelion/blob/master/LICENSE.md)).
|
||||
The app is licensed GPL v3. Localization files and resources (strings\*.xml) are licensed CC0 1.0.
|
||||
For more licensing informations, see [`3rd party licenses`](/app/src/main/res/raw/licenses_3rd_party.md).
|
||||
|
||||
<!--
|
||||
## Screenshots
|
||||
<div style="display:flex;" >
|
||||
<img src="https://raw.githubusercontent.com/diaspora-for-android/dandelion-metadata-latest/master/en-US/phoneScreenshots/01.png" width="19%" >
|
||||
<img src="https://raw.githubusercontent.com/diaspora-for-android/dandelion-metadata-latest/master/en-US/phoneScreenshots/02.png" width="19%" style="margin-left:10px;" >
|
||||
<img src="https://raw.githubusercontent.com/diaspora-for-android/dandelion-metadata-latest/master/en-US/phoneScreenshots/03.png" width="19%" style="margin-left:10px;" >
|
||||
<img src="https://raw.githubusercontent.com/diaspora-for-android/dandelion-metadata-latest/master/en-US/phoneScreenshots/04.png" width="19%" style="margin-left:10px;" >
|
||||
<img src="https://raw.githubusercontent.com/diaspora-for-android/dandelion-metadata-latest/master/en-US/phoneScreenshots/05.png" width="19%" style="margin-left:10px;" >
|
||||
</div>
|
||||
|
||||
<div style="display:flex;" >
|
||||
<img src="https://raw.githubusercontent.com/diaspora-for-android/dandelion-metadata-latest/master/en-US/phoneScreenshots/06.png" width="19%" >
|
||||
<img src="https://raw.githubusercontent.com/diaspora-for-android/dandelion-metadata-latest/master/en-US/phoneScreenshots/07.png" width="19%" style="margin-left:10px;" >
|
||||
<img src="https://raw.githubusercontent.com/diaspora-for-android/dandelion-metadata-latest/master/en-US/phoneScreenshots/08.png" width="19%" style="margin-left:10px;" >
|
||||
<img src="https://raw.githubusercontent.com/diaspora-for-android/dandelion-metadata-latest/master/en-US/phoneScreenshots/09.png" width="19%" style="margin-left:10px;" >
|
||||
</div>
|
||||
-->
|
||||
|
||||
### Notice
|
||||
#### Maintainers
|
||||
- gsantner ([GitHub](https://github.com/gsantner), [Web](https://gsantner.github.io), [diaspora*](https://pod.geraspora.de/people/d1cbdd70095301341e834860008dbc6c))
|
||||
- Bitcoin: [1B9ZyYdQoY9BxMe9dRUEKaZbJWsbQqfXU5](https://gsantner.github.io/donate/#donate)
|
||||
- vanitasvitae ([GitHub](https://github.com/vanitasvitae), [diaspora*](https://pod.geraspora.de/people/bbd7af90fbec013213e34860008dbc6c))
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue