diff --git a/README.md b/README.md index b5cb496..334a263 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ -# ParentPickup -Open source app for ensuring kids are picked up by approved adults from school, etc. +# Get My +Open source shopping / list app. + +## Keeping it Simple +- Registration / Login System built in +- 1st user to register is the system admin by default. +- All other useers are added as "user". +- No serious permissions difference as of now. +- Product Information Levels: + - Products + - Stores + - Categories + - Locations +- Lists + - 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 marked as complete and removed from view. +- List Items + - Added to specific lists + - Can be marked as + - 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.) + +## What Get My Is +- a Simple Lists App +## What Get My Is Not +- a Reminders app with calendar / timer events. +- A full ERP / CRM for your home. +- A portal or interface to any shopping / eCommerce sit online. +## Built With +- MeteorJS + - Blaze UI +- MongoDB +- Materialize-css + +## License +MIT + +Do what you want to with this project. If you make it better, share that back with me. If you make money from it, keep me in mind at some point. + +This application is provided freely, and may be modified and redistributed freely. + +There is no warranty provided or implied for this application. Use at your own risk. \ No newline at end of file