docs: updated readme

Author: Taxrosdev

README.md

@@ -1,10 +1,46 @@
 # Linked Content Addressed Storage
 
-For projects that use large amounts of duplicate files
+A simple yet complex method of storing large directory structures with duplicate files
+
+## Examples
+
+```rust
+// `input_dir` is the artifact, likely produced by a build system etc. This is what we want to "transmit".
+let input_dir = absolute(Path::new("./example_dir")).unwrap();
+// `repo_dir` is the Repo's contained directory, and should be hosted on a web server, as a directory, etc.
+let repo_dir = absolute(Path::new("./example_repo")).unwrap();
+// `store_dir` is the local path for the local store, and will be where the Store is placed, and each artifact inside.
+let store_dir = absolute(Path::new("./example_store")).unwrap();
+
+// Create an example repo and a store, *locally*
+create_repo(repo_dir.as_path())?;
+create_store(&store_dir)?;
+
+// Create an example artifact
+fs::create_dir_all(Path::new("./example_dir/nested_dir/super_nested_dir")).unwrap();
+fs::write("./example_dir/a", "Wow a file").unwrap();
+fs::write("./example_dir/nested_dir/b", "Wow another file, shocking.").unwrap();
+fs::write(
+    "./example_dir/nested_dir/super_nested_dir/c",
+    "Nested nested nested file",
+)
+.unwrap();
+
+// Compile the artifact into a manifest and chunks and store it
+build(
+    input_dir.as_path(),
+    repo_dir.as_path(),
+    &"generic".to_string(),
+)
+.expect("Build Failure");
+
+// Install the resulting manifest into an artifact in the `store_dir`
+install_artifact(&"generic".to_string(), store_dir.as_path(), &repo_dir);
+```
 
-## Using
+For further examples please check [the examples in the source tree.](https://github.com/TimelessOS/LCAS/tree/main/examples)
 
-### Terminology
+## Terminology
 
 - Repo: The storage location of all uploaded chunks, artifacts, and manifests. Commonly used by the distributer of directories.
 - Store: The storage location of all downloaded chunks and manifests, alongside the built artifacts. Commonly used by the downloader of directories.
@@ -13,17 +49,3 @@ For projects that use large amounts of duplicate files
 - Chunk: A raw deduplicated file.
 
 Please note: There is minor differences between implementation depending on whether they are in relation to the Store or Repo.
-
-### Examples
-
-For further examples please check [the examples in the source tree.](https://github.com/TimelessOS/LCAS/tree/main/examples)
-
-## Contributing
-
-### TODO
-
-- [ ] Networking support for repos
-- [ ] Error handling (Should be propogated upwards)
-- [ ] Proper tests
-- [ ] Proper/Better documentation
-- [ ] Windows Support (UNIX-Like only)