diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 9624986b..422ab5ba 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -18,5 +18,5 @@ Please make sure to: Please also try to reproduce the problem on the pre-release demo: => https://demo-prerelease.grocy.info - Use a private demo instance to make your example persistent -- If the problem is not reproducible there, it's most likely not a bug - please use the r/grocy subreddit for general questions / help: => https://www.reddit.com/r/grocy +- If the problem is not reproducible there, it's most likely not a bug - please use the r/grocy subreddit for general help and usage questions: => https://www.reddit.com/r/grocy --> diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 5f16e44b..a54bb8da 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -11,7 +11,7 @@ assignees: '' diff --git a/README.md b/README.md index 71c64228..9a29ed89 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ ## Features -See the website → +See the website. → ## Questions / Help / Bug Reports / Feature Requests @@ -84,7 +84,7 @@ _RTL languages are unfortunately not yet supported._ ## Motivation -A household needs to be managed. I did this so far (almost 10 years) with my first self written software (a C# Windows forms application) and with a bunch of Excel sheets. The software was a pain to use at the end and Excel is Excel. So I searched for and tried different things for a (very) long time, nothing 100 % fitted, so this is my aim for a "complete household management"-thing. ERP your fridge! +A household needs to be managed. Before Grocy I did this (for almost 10 years) using my first self written software (a C# Windows forms application) and with a bunch of Excel sheets. The software was a pain to use at the end and Excel is Excel. So I searched for and tried different things for a (very) long time, nothing 100 % fitted, so this is my aim for a "complete household management"-thing. ERP your fridge! ## Things worth to know @@ -92,6 +92,8 @@ A household needs to be managed. I did this so far (almost 10 years) with my fir See the integrated Swagger UI instance on [/api](https://demo.grocy.info/api). +The web frontend uses exactly this API for pretty much everything. So everything you can do there is also possible via the API. + ### Barcode readers & camera scanning Some fields (with a barcode icon above) also allow to select a value by scanning a barcode. It works best when your barcode reader prefixes every barcode with a letter which is normally not part of a item name (I use a `$`) and sends a `TAB` after a scan. @@ -105,11 +107,11 @@ _My personal recommendation: Use a USB barcode laser scanner. They are cheap and For (productivity) reasons all date (and time) input (and display) fields use the ISO-8601 format regardless of localization. The following shorthands are available: - `MMDD` gets expanded to the given day on the current year, if > today, or to the given day next year, if < today, in proper notation - - Example: `0517` will be converted to `2023-05-17` + - Example: `0517` will be converted to `2024-05-17` - `YYYYMMDD` gets expanded to the proper ISO-8601 notation - - Example: `20230417` will be converted to `2023-04-17` + - Example: `20240417` will be converted to `2024-04-17` - `YYYYMMe` or `YYYYMM+` gets expanded to the end of the given month in the given year in proper notation - - Example: `202307e` will be converted to `2023-07-31` + - Example: `202407e` will be converted to `2024-07-31` - `[+/-]n[d/m/y]` gets expanded to a date relative to today, while adding (**+**) or subtracting (**-**) the **n**umber of **d**ays/**m**onths/**y**ears, in proper notation - Example: `+1m` will be converted to the same day next month - `x` gets expanded to `2999-12-31` (which is an alias for "never overdue") @@ -135,7 +137,7 @@ There is no plugin included for any service, see the reference implementation in Database schema migration is automatically done when visiting the root (`/`) route (click on the logo in the left upper edge). -_Please note: Database migrations are supposed to work between releases, not between every commit. If you want to run the current `master` branch (which is the development version), you need to handle that (and maybe more) yourself._ +_Please note: Database migrations are supposed to work between releases, not between every commit. If you want to run the current `master` branch (which is the development version), you need to handle that (and more) yourself._ ### Disable certain features