Added licence, updated readme (#11)

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ChargePi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+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.

README.md

@@ -1,13 +1,14 @@
 # OCPP variable manager
 
-A library for managing OCPP 1.6 variables, with mandatory key and custom value validation.
+A library for managing OCPP 1.6 variables, with versioning, mandatory keys and custom value validation.
+It also includes sane defaults for the required configuration keys.
 
 In the future, this library will be extended to support OCPP 2.0.1 as well.
 
 ## Installing
 
 ```bash
-    go get github.com/ChargePi/ocppManager-go
+  go get github.com/ChargePi/ocppManager-go
 ```
 
 ## ⚡ Usage
@@ -18,10 +19,10 @@ Check out the full [example](examples/v16/example.go). It also contains a sample
 package main
 
 import (
+	"github.com/ChargePi/ocppManager-go/ocpp_v16"
 	"github.com/lorenzodonini/ocpp-go/ocpp1.6/core"
 	"github.com/lorenzodonini/ocpp-go/ocpp1.6/smartcharging"
 	log "github.com/sirupsen/logrus"
-	"github.com/ChargePi/ocppManager-go/ocpp_v16"
 )
 
 func main() {
@@ -77,3 +78,18 @@ func main() {
 }
 
 ```
+
+## Notes
+
+1. This library is still in development, and the API might change in the future.
+2. Storing the configuration is not part of this library. You can use a database, a file, or any other storage mechanism
+   to store the configuration by getting the configuration as a map and storing it in your preferred way.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.
+
+## Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull
+requests to us.