chore: comments and docs

decentraland · May 28, 2019 · 2740548 · 2740548
1 parent 0d6e9a0
commit 2740548
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,11 @@
 # Server [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 Set of common functionality accross Decentraland servers.
+You can install it using npm by running:
+
+```bash
+npm install --save decentraland-server
+```
 
 ### Scripts
 

diff --git a/src/Model.ts b/src/Model.ts
@@ -15,12 +15,6 @@ export class Model<T> {
    */
   public static db: Postgres = clients.postgres
 
-  /**
-   * Checks to see if all column names exist on the attributes object.
-   * If you need a more complex approach (skipping NULLABLE columns for example) you can override it.
-   * @param  attributes - Model attributes to check
-   * @return True if at least one of the properties don't exist on the object
-   */
   public attributes: T
   public tableName: string
   public primaryKey: keyof T