docs: added readme

Ghamza-Jd · Mar 31, 2024 · e64385d · e64385d
1 parent f0e5879
commit e64385d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/napmap/Cargo.toml b/napmap/Cargo.toml
@@ -3,7 +3,7 @@ name = "napmap"
 version = "0.1.0"
 authors.workspace = true
 description.workspace = true
-readme.workspace = true
+readme = "./README.md"
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true

diff --git a/napmap/README.md b/napmap/README.md
@@ -0,0 +1,3 @@
+# NapMap
+
+`NapMap` is a map that sends the task to sleep if the requested data do not exist and notify them once available.