Sergio Cinos avatar Sergio Cinos committed 86edcda

More info for the README

Comments (0)

Files changed (1)

 
 * Exports ComicVine API resources as Backbone collections, ready to be consumed.
 * Uses Redis for caching API responses.
+* Modeled resources:
+   * Characters
+   * Concepts
+   * Issues
+   * Locations
+   * Movies
+   * Objects
+   * Origins
+   * Persons
+   * Powers
+   * Publishers
+   * StoryArcs
+   * Teams
+   * Volumes
 
 Dependencies
 ============
 * [caching](https://github.com/mape/node-caching), used to provide a redis caching layer
 
 
+Tests
+=====
+
+The module provides a set of tests (althougt some methods doesn't have tests yet). The tests has been created using [mocha](http://visionmedia.github.com/mocha/). To run the tests:
+
+* Install mocha globally
+    $ npm install -g mocha
+    $ cd comicvine-client
+    $ mocha
+
+* If you have mocha installed as a dependency
+    $ cd comicvine-client
+    $ npm install mocha
+    $ node_modules/mocha/bin/mocha
+
+
 Usage
-========
+=====
 
 ### Initialization
 
          apikey: "40ffdec6b2f84ffa415b5f24d289175ae907a6a1",
 
          //Don't use cache
+         //It is *highly recommended* to not disable the cache. ComicVine API is not very fast and very verbose, so
+         //not using cache will definetly kill your performance.
          cache: false
      });
 
 
-It is **highly recommended** to not disable the cache. ComicVine API is not very fast and very verbose, so not using cache will definetly kill your performance.
-
-
 ### Get a paginated list of characters
 
     client.collections.pageSize = 20; //100 by default
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.