Craig Fletcher 4 anni fa
parent
commit
6aa11dd37a
1 ha cambiato i file con 7 aggiunte e 0 eliminazioni
  1. 7 0
      README.md

+ 7 - 0
README.md

@@ -5,10 +5,14 @@ Quick and dirty API boilerplate, using:
   * Yup for validation
   * Restify for the web server/routing
   * Winston for logging
+  * ESLint for linting
 
 There are many limitations to this configuration, it is intended as a
 debugging/prototyping tool.
 
+There are fairly few dependencies in this boilerplate, and most things are
+simply factories with instances passed in.
+
 
 ## Usage
 
@@ -30,6 +34,9 @@ Objects are stored in redis by calculating the sha256 hash, hex digest from a
 "path" array for convenience (e.g. `["users", req.params.userName, "stats",
 "visits"]`).
 
+There is no hardening or security intention behind this - it's simply a fast
+hash to use as an ID.
+
 
 ## Routes