aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorvlad <vlad@drivergrp.com>2016-09-19 17:30:38 -0700
committervlad <vlad@drivergrp.com>2016-09-19 17:30:38 -0700
commit217ab29e22c119351e1fbd0bcbe6a7a44f1aed2b (patch)
tree5dc2d6d50d452b1e0c607148e53eb79f97a6c920 /README.md
parentaa9ae44ce56d12e9b591c5795487908987b8ddc3 (diff)
downloaddriver-core-217ab29e22c119351e1fbd0bcbe6a7a44f1aed2b.tar.gz
driver-core-217ab29e22c119351e1fbd0bcbe6a7a44f1aed2b.tar.bz2
driver-core-217ab29e22c119351e1fbd0bcbe6a7a44f1aed2b.zip
Updated README.md file
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index 4a3104a..25ada84 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,15 @@ Core library is used to provide ways to implement practices established in [Driv
## Components
- * `core package` provides `Id` and `Name` implementations and also `make` and `using` functions,
+ * `core package` provides `Id` and `Name` implementations (with equal and ordering) and also `make` and `using` functions,
* `time` Primitives to deal with time and receive current times in code,
* `config` Contains method `loadDefaultConfig` with default way of providing config to the application,
* `messages` Localization messages supporting different locales and methods to read from config,
* `database` Method for database initialization from config, `Id` and `Name` mapping and schema lifecycle,
* `rest` Wrapper over call to external REST API, does logging and stats call,
+ * `json` Json formats for `Id`, `Name`, `Time`, `Revision` and converters for enums and value classes,
+ * `auth` Permissions and roles, auth token definitions, `authorize` directive to verify auth token,
+ * `file` Stub for file storage web-service and implementations for S3 and FS `FileStorage`,
* `app` Base class for Driver service, which initializes swagger, app modules and its routes.
* `generators` Set of functions to prototype APIs. Combine with `faker` package,
* `stats` Interface to the infrastructure statistics service, currently just logs events,
@@ -95,8 +98,6 @@ For more examples check [project tests](https://github.com/drivergroup/driver-co
## Things to do
- * Bring sbt-release plugin to core
-
* Logging:
* Custom akka-http directive to log and record stats for all incoming requests, use akka-http built-in `logRequestResult("log")` as example and probably extend that,