Update README

.github/workflows/docs.yml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - master
+    path-ignore:
+      - 'README.md'
   release:
     types: [published]
 

.github/workflows/tests.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - master
     path-ignore:
-      - 'README.rst'
+      - 'README.md'
   release:
     types: [published]
 

README.md

@@ -0,0 +1,44 @@
+# Deser
+
+**Deser is a serialization and deserialization library for Nim**
+
+[Deser documentation](https://deser.nim.town/)
+
+## Installation
+
+```
+nimble install deser
+```
+
+or
+
+```nim
+requires "nim >= 1.4.2, deser >= 0.1.3"
+```
+
+## Usage
+
+```nim
+import macros, options, times
+import deser, deser_json
+
+type
+  Foo {.skipSerializeIf(isNone), renameAll(rkSnakeCase).} = object
+    id: int
+    someOption: Option[int]
+    date {.serializeWith(toUnix), deserializeWith(fromUnix).}: Time
+
+const js = """
+  {
+    "id": 123,
+    "some_option": 321,
+    "date": 1214092800
+  }
+"""
+
+var f = js.parse().to(Foo)
+
+f.someOption = none(int)
+
+assert f.dumps() == """{"id":123,"date":1214092800}"""
+```