Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README UPDATE.md #25

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions README UPDATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# <img src="https://f-droid.org/repo/icons-640/com.woefe.shoppinglist.9.png" width="50" height="50"/> Shopping List

## ShoppingList
Shopping List is an open source software that allows users create and manage shopping lists and any other desired kind of list. The lists created are in simple text format (.txt) which can be shared to other third party products or services and can be synchronized with other devices by utilizing applications such as [Syncthing](https://syncthing.com/) and [Nextcloud](https://nextcloud.com/)

<a href="https://f-droid.org/packages/com.woefe.shoppinglist/" target="_blank">
<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="80"/>
</a>

## Shopping list features

- Simple UI, very easy to understand and navigate around the app
- Shopping lists are in plain text format(txt)
- Ability to synchronize lists between multiple devices
- Shopping lists can be shared to available and compatible third party apps.
- Customization of storage location for list files


### Shopping List Syntax

The syntax of a ShoppingList file is quite simple and easy to read and edit.

* The very first line of the file is the name of the list in square brackets
* Empty lines or lines with only whitespaces are ignored
* Every item of the list corresponds to a single line in the file
* Checked items start with `//`
* Specifying the amount of an item is optional
* The amount of an item and its name are separated by the #-Sign

Example of a shopping list synthax
```
[ ShoppingList ]

Milk
Bananas #
Juice #2 Liters
// Eggs #12
```

## Licensing

This software is licensed under [GPLV3+](https://raw.githubusercontent.com/woefe/ShoppingList/master/COPYING)


## Privacy Policy

Wolfgang Popp built the Shopping List app as an Open Source app. This SERVICE is provided by Wolfgang Popp at no cost and is intended for use as is.

This policy documentation is used to inform users of shopping list software regarding my policies with the collection, use, and disclosure of Personal Information if anyone decided to use my Service.

If you choose to use my Service, then you agree to the collection and use of information in relation to this policy. The Personal Information that I collect is used for providing and improving the Service. I will not use or share your information with anyone except as described in this Privacy Policy.

The terms used in this Privacy Policy have the same meanings as in our Terms and Conditions, which is accessible at Shopping List unless otherwise defined in this Privacy Policy.

## Information Collection and Use

For a better experience, while using our Service, I may require you to provide us with certain personally identifiable information, including but not limited to modify or delete contents of your SD card, read the contents of your SD card. The information that I request is retained on your device and is not collected by me in any way

The app does use third party services that may collect information used to identify you.

## Security

I value your trust in providing us your Personal Information, thus we are striving to use commercially acceptable means of protecting it. But remember that no method of transmission over the internet, or method of electronic storage is 100% secure and reliable, and I cannot guarantee its absolute security.

## Changes to This Privacy Policy

I may update the Privacy Policy from time to time. Thus, you are advised to review this document periodically for any changes. These changes are effective immediately after they are modified on this documment. <hr>

## Contributions

This project is open to various forms of contributions which may include translations, or suggestions of features for the app.
To contribute to this project you can quickly open an issue, create a pull request or contact the developer on [github](https://github.com/woefe)
30 changes: 0 additions & 30 deletions README.md

This file was deleted.