Update readme

This commit is contained in:
2020-03-02 17:10:25 +11:00
parent d004808ea1
commit d0e7abbbc2
+11
View File
@@ -1,5 +1,9 @@
# Zendesk Code Challenge
## How does it application work
## How to
### How to run
@@ -51,3 +55,10 @@ go test ./... -cover
GITHUB_RUN_NUMBER=1 ./auto/build
```
## If I had more time / What can I improve
- Better object printing instead of using `spew.Dump()`
- Reuse more shard logic especially in `search/index.go`, but due to Go missing generics concept it's different when compare to `Ruby`, `Java` and some other popular languages.
- Add more tests, due to this code test costs me a lot of time to complete, so I didn't cover all the code currently, but I am keen to add more tests if possible.
- Better user experience in CLI application, current the cli app is very basic and go can't go back to previous menu.