Initial README (#15)

* Initial README * Review feedback
osmosis-labs · Jun 2, 2023 · a5b0e66 · a5b0e66
1 parent 9053cb3
commit a5b0e66
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+# Mesh Security SDK
+
+Cosmos module for mesh-security consumer chains. Please see the official project [repo](https://github.com/osmosis-labs/mesh-security)
+for specs and wasm contracts.
+
+## Project Structure
+
+* x - module code that is supposed to be imported by consumer chains
+* demo - contains an example application and CLI that is using the mesh-security module
+* tests/e2e - end-to-end tests with the demo app and contracts