diff --git a/README.md b/README.md index 3f5079fc..766b078b 100644 --- a/README.md +++ b/README.md @@ -7,35 +7,46 @@ Nextcloud Cospend is a group/shared budget manager. It was inspired by the great [IHateMoney](https://github.com/spiral-project/ihatemoney/). -You can use it when you share a house, when you go on vacation with friends, whenever you share money with others. +You can use it when you share a house, when you go on vacation with friends, whenever you share expenses with a group of people. It lets you create projects with members and bills. Each member has a balance computed from the project bills. -This way you can see who owes the group and who the group owes. Ultimately you can ask for a settlement plan telling you which payments to make to reset members balances. +Balances are not an absolute amount of money at members disposal but rather a relative information +showing if a member has spent more for the group than the group has spent for her/him, independently of exactly who spent money for whom. +This way you can see who owes the group and who the group owes. +Ultimately you can ask for a settlement plan telling you which payments to make to reset members balances. Project members are independent from Nextcloud users. -Projects can be accessed and modified by people without a Nextcloud account. Each project has an ID and a password for guest access. +Projects can be shared with other Nextcloud users or via public links. [MoneyBuster](https://gitlab.com/eneiluj/moneybuster) Android client is [available in F-Droid](https://f-droid.org/packages/net.eneiluj.moneybuster/) and on the [Play store](https://play.google.com/store/apps/details?id=net.eneiluj.moneybuster). -[PayForMe](https://github.com/mayflower/PayForMe) iOS client is currently being developped! +[PayForMe](https://github.com/mayflower/PayForMe) iOS client is currently under developpement! + +The private and public APIs are documented using [the Nextcloud OpenAPI extractor](https://github.com/nextcloud/openapi-extractor/). +This documentation can be accessed directly in Nextcloud. +All you need is to install Cospend (>= v1.6.0) and use the +[the OCS API Viewer app](https://apps.nextcloud.com/apps/ocs_api_viewer) to browse the OpenAPI documentation. ## Features -* ✎ create/edit/delete projects, members, bills, bill categories, currencies -* ⚖ check member balances -* 🗠 display project statistics -* ♻ display settlement plan -* 🎇 automatically create reimbursement bills from settlement plan -* 🗓 create recurring bills (day/week/month/year) -* 📊 optionally provide custom amount for each member in new bills -* 🔗 link bills with personal files (picture of physical bill for example) -* 👩 guest access for people outside Nextcloud -* 👫 share projects with Nextcloud users/groups/circles -* 🖫 import/export projects as csv (compatible with csv files from IHateMoney and SplitWise) -* 🔗 generate link/QRCode to easily import projects in MoneyBuster -* 🗲 implement Nextcloud notifications and activity stream +* ✎ Create/edit/delete projects, members, bills, bill categories, currencies +* ⚖ Check member balances +* 🗠 Display project statistics +* ♻ Display settlement plan +* Move bills from one project to another +* Move bills to trash before actually deleting them +* Archive old projects before deleting them +* 🎇 Automatically create reimbursement bills from settlement plan +* 🗓 Create recurring bills (day/week/month/year) +* 📊 Optionally provide custom amount for each member in new bills +* 🔗 Link personal files to bills (picture of physical receipt for example) +* 👩 Public links for people outside Nextcloud (can be password protected) +* 👫 Share projects with Nextcloud users/groups/circles +* 🖫 Import/export projects as csv (compatible with csv files from IHateMoney and SplitWise) +* 🔗 Generate link/QRCode to easily add projects in MoneyBuster +* 🗲 Implement Nextcloud notifications and activity stream -This app is tested on Nextcloud 20+ with Firefox 57+ and Chromium. +This app usually support the 2 or 3 last major versions of Nextcloud. This app is under development. diff --git a/l10n/descriptions/full_description.md b/l10n/descriptions/full_description.md index 2ad0834d..9f010798 100644 --- a/l10n/descriptions/full_description.md +++ b/l10n/descriptions/full_description.md @@ -3,53 +3,64 @@ Nextcloud Cospend is a group/shared budget manager. It was inspired by the great [IHateMoney](https://github.com/spiral-project/ihatemoney/). -You can use it when you share a house, when you go on vacation with friends, whenever you share money with others. +You can use it when you share a house, when you go on vacation with friends, whenever you share expenses with a group of people. It lets you create projects with members and bills. Each member has a balance computed from the project bills. -This way you can see who owes the group and who the group owes. Ultimately you can ask for a settlement plan telling you which payments to make to reset members balances. +Balances are not an absolute amount of money at members disposal but rather a relative information +showing if a member has spent more for the group than the group has spent for her/him, independently of exactly who spent money for whom. +This way you can see who owes the group and who the group owes. +Ultimately you can ask for a settlement plan telling you which payments to make to reset members balances. Project members are independent from Nextcloud users. -Projects can be accessed and modified by people without a Nextcloud account. Each project has an ID and a password for guest access. +Projects can be shared with other Nextcloud users or via public links. [MoneyBuster](https://gitlab.com/eneiluj/moneybuster) Android client is [available in F-Droid](https://f-droid.org/packages/net.eneiluj.moneybuster/) and on the [Play store](https://play.google.com/store/apps/details?id=net.eneiluj.moneybuster). -[PayForMe](https://github.com/mayflower/PayForMe) iOS client is currently being developped! +[PayForMe](https://github.com/mayflower/PayForMe) iOS client is currently under developpement! + +The private and public APIs are documented using [the Nextcloud OpenAPI extractor](https://github.com/nextcloud/openapi-extractor/). +This documentation can be accessed directly in Nextcloud. +All you need is to install Cospend (>= v1.6.0) and use the +[the OCS API Viewer app](https://apps.nextcloud.com/apps/ocs_api_viewer) to browse the OpenAPI documentation. ## Features -* ✎ create/edit/delete projects, members, bills, bill categories, currencies -* ⚖ check member balances -* 🗠 display project statistics -* ♻ display settlement plan -* 🎇 automatically create reimbursement bills from settlement plan -* 🗓 create recurring bills (daily/weekly/monthly/yearly) -* 📊 optionally provide custom amount for each member in new bills -* 🔗 link bills with personal files (picture of physical bill for example) -* 👩 guest access for people outside Nextcloud -* 👫 share projects with Nextcloud users/groups/circles -* 🖫 import/export projects as csv (compatible with csv files from IHateMoney) -* 🔗 generate link/QRCode to easily import projects in MoneyBuster -* 🗲 implement Nextcloud notifications and activity stream +* ✎ Create/edit/delete projects, members, bills, bill categories, currencies +* ⚖ Check member balances +* 🗠 Display project statistics +* ♻ Display settlement plan +* Move bills from one project to another +* Move bills to trash before actually deleting them +* Archive old projects before deleting them +* 🎇 Automatically create reimbursement bills from settlement plan +* 🗓 Create recurring bills (day/week/month/year) +* 📊 Optionally provide custom amount for each member in new bills +* 🔗 Link personal files to bills (picture of physical receipt for example) +* 👩 Public links for people outside Nextcloud (can be password protected) +* 👫 Share projects with Nextcloud users/groups/circles +* 🖫 Import/export projects as csv (compatible with csv files from IHateMoney and SplitWise) +* 🔗 Generate link/QRCode to easily add projects in MoneyBuster +* 🗲 Implement Nextcloud notifications and activity stream -This app is tested on Nextcloud 20+ with Firefox 57+ and Chromium. +This app usually support the 2 or 3 last major versions of Nextcloud. This app is under development. 🌍 Help us to translate this app on [Nextcloud-Cospend/MoneyBuster Crowdin project](https://crowdin.com/project/moneybuster). -⚒ Check out other ways to help in the [contribution guidelines](https://github.com/eneiluj/cospend-nc/blob/master/CONTRIBUTING.md). +⚒ Check out other ways to help in the [contribution guidelines](https://github.com/julien-nc/cospend-nc/blob/master/CONTRIBUTING.md). ## Documentation -* [User documentation](https://github.com/eneiluj/cospend-nc/blob/master/docs/user.md) -* [Admin documentation](https://github.com/eneiluj/cospend-nc/blob/master/docs/admin.md) -* [Developer documentation](https://github.com/eneiluj/cospend-nc/blob/master/docs/dev.md) -* [CHANGELOG](https://github.com/eneiluj/cospend-nc/blob/master/CHANGELOG.md#change-log) -* [AUTHORS](https://github.com/eneiluj/cospend-nc/blob/master/AUTHORS.md#authors) +* [User documentation](https://github.com/julien-nc/cospend-nc/blob/master/docs/user.md) +* [Admin documentation](https://github.com/julien-nc/cospend-nc/blob/master/docs/admin.md) +* [Developer documentation](https://github.com/julien-nc/cospend-nc/blob/master/docs/dev.md) +* [CHANGELOG](https://github.com/julien-nc/cospend-nc/blob/master/CHANGELOG.md#change-log) +* [AUTHORS](https://github.com/julien-nc/cospend-nc/blob/master/AUTHORS.md#authors) ## Known issues -* it does not make you rich +* It does not make you rich Any feedback will be appreciated.