fix: update readme, fix broccoli tree options

Author: davewasmer

README.md

@@ -1,4 +1,68 @@
 # Documenter
 
-Documenter is a flexible tool for generating documentation for your Denali project (app or addon). Generated docs can be published to your own hosted website, to the central Denali documentation repository (docs.denalijs.org), or even run locally to give you offline, versioned docs for free.
+Generate documentation for your JavaScript or Typescript projects!
 
+Includes support for API reference docs generated automatically from code comments, as well as Markdown guides.
+
+Documenter does not generate HTMl or any other kind of rendered output - it only extracts the documentation from your codebase and supplies it in a structured, consistent format for you to render as you wish.
+
+Used by the [Denali CLI](denalijs.org) to generate documentation for Denali projects, but it's not tied to Denali projects only.
+
+## Usage
+
+You can use the extracter directly:
+
+```js
+import { Extracter } from 'documenter';
+
+let extracter = new Extracter({
+
+  // The base directory to start everything from
+  dir: process.cwd(),
+
+  // The directory to scan for Markdown files
+  pagesDir: 'guides',
+
+  // An array of glob patterns to search for source files
+  sourceDirs: [ 'src' ],
+
+  // The name of the project
+  projectName: 'typescript-project',
+
+  // The current version of the project
+  projectVersion: '1.0.0'
+
+});
+
+let docs = extracter.extract();
+```
+
+Or, if you happen to be using Broccoli, you can use the Broccoli plugin:
+
+```js
+import { ExtracterTree } from 'documenter';
+
+// inputTree should contain the pages and source you want to extract
+// All paths will be relative to the inputTree
+let extracter = new ExtracterTree(inputTree, {
+
+  // The directory to scan for Markdown files
+  pagesDir: 'guides',
+
+  // An array of glob patterns to search for source files
+  sourceDirs: [ 'src' ],
+
+  // The name of the project
+  projectName: 'typescript-project',
+
+  // The current version of the project
+  projectVersion: '1.0.0'
+
+});
+
+// The Broccoli plugin will write out the resulting docs data to `docs.json`
+// If a `docs.json` exists in the inputTree, it will simply copy that over
+// and skip the extraction.
+```
+
+For an example of what the final docs structure looks like, check the [test output helper file](https://github.com/denali-js/documenter/blob/master/test/helpers/output-expectation.js).

src/trees/extracter.ts

@@ -24,9 +24,13 @@ export default class ExtracterTree extends Tree {
 
   options: {
     /**
-     * The root directory of the project to extract documentation from
+     * The name of the project we are extracting docs from
      */
-    dir: string;
+    projectName: string;
+    /**
+     * The version string of the project we are extracting docs from
+     */
+    projectVersion: string;
     /**
      * The path to the directory containing all the Pages to build, relative to `dir`. Defaults to `docs`
      */
@@ -48,7 +52,6 @@ export default class ExtracterTree extends Tree {
     options.sourceDirs = options.sourceDirs || [ 'src' ];
     options.pagesDir = options.pagesDir || 'docs';
     this.options = <any>options;
-    this.projectPkg = readPkg(options.dir);
   }
 
   build() {
@@ -59,11 +62,11 @@ export default class ExtracterTree extends Tree {
       fs.writeFileSync(path.join(this.outputPath, 'docs.json'), docs);
     } else {
       let extracter = new Extracter({
-        projectName: this.projectPkg.name,
-        projectVersion: this.projectPkg.version,
-        dir: this.options.dir,
-        sourceDirs: this.options.sourceDirs.map((dir) => path.join(input, dir)),
-        pagesDir: path.join(input, this.options.pagesDir)
+        dir: input,
+        projectName: this.options.projectName,
+        projectVersion: this.options.projectVersion,
+        sourceDirs: this.options.sourceDirs,
+        pagesDir: this.options.pagesDir
       });
       let docs = extracter.extract();
       fs.writeFileSync(path.join(this.outputPath, 'docs.json'), JSON.stringify(docs));