Merge pull request #1 from zprobst/docs/README

Add readme

Author: zprobst

Cargo.toml

@@ -9,9 +9,6 @@ repository = "https://github.com/zprobst/amalgamator"
 [dependencies]
 serde = { version = "1", optional = true }
 
-[features]
-serde = ["dep:serde"]
-
 [dev-dependencies]
 serde_json = "1"
 serde = { version = "1",  features = ["derive"] }   

README.md

@@ -0,0 +1,29 @@
+# `amalgamator` 
+
+## Description
+
+`amalgamator` is a set/map like data structure that allows you to combine members of the set/map together based on some criteria. 
+
+This is useful when you want to merge objects together that aren't strictly equal, but are similar enough that you want to treat them as the same object.
+
+## Installation
+
+```bash
+cargo add amalgamator
+```
+
+### Serde Support
+
+If you want to use `serde` support, you can enable the `serde` feature.
+
+```bash
+cargo add amalgamator --features serde
+```
+
+## Documentation
+
+View the docs on the docs.rs [Documentation](https://docs.rs/amalgamator) page.
+
+## License
+
+This project is licensed under the MIT license or the Apache 2.0 license, at your option.