From 7dc091e6b9a9350e411a644d26b9b59cb104d684 Mon Sep 17 00:00:00 2001 From: Brian McGonagill Date: Wed, 14 Aug 2024 16:07:55 -0500 Subject: [PATCH] Updates to README --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 86c59e2..45f10b7 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,15 @@ services: 6. move back to the bundle folder, and run `node main.js`. This will start the application running. 7. There are multiple node applications to help keep a node js app running in the background, like PM2, etc...but I'll leave that up to you to get going. +## Documentation +The documentation for Get My is a work in progress. Please bare with me until I am able to get it done. I'll work on it as I have time. + +You can find the [documentation here](https://getmydocs.opensourceisawesome.com). + +The documentation is being done in the amazing open source software [Bookstack](https://www.bookstackapp.com/). + +If you'd like to contribute by writing some documentation, please contact me me with an, and I'll see about getting you access to contribute. + ## Keeping it Simple - Registration / Login System built in - 1st user to register is the system admin by default. @@ -95,10 +104,10 @@ services: - A full ERP / CRM for your home. - A portal or interface to any shopping / eCommerce sit online. ## Built With -- MeteorJS +- [MeteorJS](https://www.meteor.com/) - Blaze UI -- MongoDB -- Materialize-css +- [MongoDB](https://www.mongodb.com/) +- [Materialize-css](https://materializeweb.com/) ## License MIT @@ -108,4 +117,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.