Updated Readme

This commit is contained in:
Brian McGonagill 2024-07-25 10:36:06 -05:00
parent 40af926104
commit 0fe3bae5dd

View file

@ -5,12 +5,11 @@ Open source shopping / list app.
- Registration / Login System built in - Registration / Login System built in
- 1st user to register is the system admin by default. - 1st user to register is the system admin by default.
- All other useers are added as "user". - All other useers are added as "user".
- No serious permissions difference as of now. - No serious permissions difference as of now other than system settings and user management for the system admin.
- Product Information Levels: - Product Information Levels:
- Products - Products
- Stores - Product Name
- Categories - Store you most frequently buy it at (optional)
- Locations
- Lists - Lists
- Can be shared with other users to add items (green text) - Can be shared with other users to add items (green text)
- Can be private for keeping your own list of things to buy or tasks to do. - Can be private for keeping your own list of things to buy or tasks to do.
@ -19,7 +18,25 @@ Open source shopping / list app.
- Added to specific lists - Added to specific lists
- Can be marked as - Can be marked as
- Ordered (crossed out on list, but visible) - Ordered (crossed out on list, but visible)
- Received (check mark, and removed from visible list, but can be seen by selecting an option at the top of the list if needed.) - Received (check mark icon to remove from visible list, but can be seen by selecting an option at the top of the list if needed.)
- Tasks
- A simple todo list of tasks that can be made for yourself, or if you're an admin, for others on the system, and a due date can be assigned. No reminders, or push notifications, just open it, and look at your list of todos, then mark it complete when you finish one.
- Add Todo Items
- Add Due Date
- Mark Items as Completed
- See Overdue items in a different color (need an icond for this too)
- Menus
- Create a Menu (we like to create one for a week or so, but you can create different Menus at the same time)
- Add menu items to a simple menu list.
- Name a Menu (e.g. Guisado, Beans, Rice, side-salad)
- Pick a date to serve the item.
- Dashboard shows the item for that day.
- Shift the menu by 1 day with a simple click (we use this when we end up eating something else in the middle of menu week.)
- User Config
- Dark Mode Preference
- System Config
- Allow / Disallow Registration
- Allow / Disallow System Admin registration
## What Get My Is ## What Get My Is
- a Simple Lists App - a Simple Lists App