Update documentation. | AJ sucks (C) whatthecommit.com

Author: daggerok

FindBugsFilters.xml

@@ -2,4 +2,5 @@
 <!-- exclude UPM_UNCALLED_PRIVATE_METHOD in order to use private on(@Observes ... event) methods -->
 <FindBugsFilter>
   <Bug code="UPM"/>
+  <Bug code="UrF"/>
 </FindBugsFilter>

docs/_config.yml

@@ -19,7 +19,7 @@ description: >- # this means to ignore newlines until "baseurl:"
   Building File based event-store with Jackson JSON
   Serialisation and Deserialization, Jersey REST API
   uses Netty runtime and Weld CDI
-baseurl: /jersey-netty-cdi-jackson-file-eventstore # the subpath of your site, e.g. /blog
+baseurl: /jersey-netty-cdi-jackson-file-eventstore/ # the subpath of your site, e.g. /blog
 url: "" # the base hostname & protocol for your site, e.g. http://example.com
 #twitter_username: daggerok
 github_username:  daggerok

docs/about.md

@@ -0,0 +1,82 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+layout: post
+title:  "Developer Guide"
+date:   2019-09-01 05:11:51 +0300
+---
+_clone repo_
+
+```bash
+git clone --depth=1 https://github.com/daggerok/jersey-netty-cdi-jackson-file-eventstore.git app
+cd app/
+```
+
+
+_run fat jar_
+
+```bash
+./mvnw package ; java -jar target/*-all.jar
+```
+
+_test event-stpre_
+
+```bash
+echo '[
+  {
+    "type":"CounterCreated",
+    "aggregateId": "00000000-0000-0000-0000-000000000000",
+    "counterName": "hello 1"
+  },
+  {
+    "type":"CounterIncremented",
+    "aggregateId": "00000000-0000-0000-0000-000000000000",
+    "by": "max",
+    "withValue": 2
+  },
+  {
+    "type":"CounterIncremented",
+    "aggregateId": "00000000-0000-0000-0000-000000000000",
+    "by": "max",
+    "withValue": 3
+  },
+  {
+    "type":"CounterIncremented",
+    "aggregateId": "00000000-0000-0000-0000-000000000000",
+    "by": "max"
+  },
+  {
+    "type":"CounterSuspended",
+    "aggregateId": "00000000-0000-0000-0000-000000000000",
+    "reason": "because!"
+  }
+]' | http post :8080/events/collection
+
+http :8080/events/00000000-0000-0000-0000-000000000000 Accept:application/json
+http :8080/events/00000000-0000-0000-0000-000000000001/collection Accept:application/json
+```
+
+
+NOTE: _This project has been based on [GitHub: daggerok/main-starter (branch: maven-java)](https://github.com/daggerok/main-starter/tree/maven-java)_
+
+links:
+
+* [Overriding Jackson ObjectMapper Provider in Jersey](https://stackoverflow.com/a/5234682/1490636)
+* [spotbugs plugin](https://spotbugs.readthedocs.io/en/stable/)
+
+_quick project docs jekyll guide_
+
+```bash
+cd docs
+bundle
+bundle exec just-the-docs rake search:init
+bundle exec jekyll serve
+bundle exec jekyll build
+mv -v _site
+```
+
+Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].
+
+[jekyll-docs]: https://jekyllrb.com/docs/home
+[jekyll-gh]:   https://github.com/jekyll/jekyll
+[jekyll-talk]: https://talk.jekyllrb.com/