Skip to content

Commit

Permalink
chore: update readme (#972)
Browse files Browse the repository at this point in the history
* chore: update the readme

* chore: update fastlane files

* chore: update license date in readme

* chore: add a basic privacy policy

Add a basic privacy policy, hopefully its enough for Google.
  • Loading branch information
Chesire authored Apr 23, 2023
1 parent 0f3c1aa commit 27362e6
Show file tree
Hide file tree
Showing 16 changed files with 28 additions and 17 deletions.
37 changes: 20 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,14 @@
Nekome is an Android application that helps with tracking your anime and manga watch lists. Watch list data is handled by [Kitsu](https://kitsu.io/).

[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Download from F-Droid"
height="80">](https://f-droid.org/packages/com.chesire.nekome/)
alt="Download from F-Droid"
height="80">](https://f-droid.org/packages/com.chesire.nekome/)
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
alt="Download from Google Play"
height="80">](https://play.google.com/store/apps/details?id=com.chesire.nekome)

![List](screenshots/list.png) ![detail](screenshots/detail.png)
![List](fastlane/metadata/android/en-GB/images/phoneScreenshots/1_en-GB.png)
![detail](fastlane/metadata/android/en-GB/images/phoneScreenshots/3_en-GB.png)

## Features

Expand All @@ -27,7 +28,9 @@ Nekome is an Android application that helps with tracking your anime and manga w
* Support for Android 21+
* Fully Kotlin
* Uses [Kitsu](https://kitsu.io/) to store information, all accessed through [their API](https://kitsu.docs.apiary.io/)
* [Architecture components](https://developer.android.com/topic/libraries/architecture) (LiveData, ViewModels, Room)
* [MVVM](https://developer.android.com/topic/libraries/architecture) for the architecture
* [Compose](https://developer.android.com/jetpack/compose) for the UI layer
* [Material3](https://developer.android.com/jetpack/compose/designsystems/material3) support for dynamic themes using Material 3
* [Hilt](https://dagger.dev/hilt/) for dependency injection
* [Retrofit](https://github.com/square/retrofit) to aid with API communicaton
* [Moshi](https://github.com/square/moshi) for parsing JSON
Expand All @@ -41,16 +44,16 @@ For contributing to the project, please feel free to [create an issue](https://g

## License

Copyright (C) 2020 Troy Rijkaard
Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.
Copyright (C) 2023 Troy Rijkaard

Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions privacypolicy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Privacy Policy

Nekome takes your privacy seriously. To better protect your privacy we provide this privacy policy notice explaining the way your personal information is collected and used.

## Collection of Information

Nekome collects the email address and password of the user for their Kitsu account to facilitate logging in and retrieve/updating their lists.
No other data is obtained or stored.
Binary file removed screenshots/detail.png
Binary file not shown.
Binary file removed screenshots/list.png
Binary file not shown.

0 comments on commit 27362e6

Please sign in to comment.