diff --git a/README.md b/README.md index 09519b1f..8bdb8514 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,22 @@ # Lot Occupancy System +**In development** + A system for managing the occupancy of lots. Built with **cemetery management** in mind, but flexible enough to handle marinas and campgrounds as well. +[User Documentation (In The Works)](docs/) + ## Key Features **Maps are optional!**
Many systems of this type start with a map, and drill down into the data from it. This can result in a huge amount of effort to get started. -This system can run "out-of-the-box" without maps, with the option to add them when it makes sense. \ No newline at end of file +This system can run "out-of-the-box" without maps, with the option to add them when it makes sense. + +## About this Project + +Although the system is quite niche, it's being released in an open source environment in hopes to pool developer resources from other municipalities looking to move away from older, legacy systems. + +It is being shared to start the dialog among other municipalities and present an option to those who may be looking to refresh their own cemetery systems. \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..31fcdaf6 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,5 @@ +[Home](https://cityssm.github.io/lot-occupancy-system/) + +# Help Documentation + +**Thank you for taking the time to read the documentation.**