Merge pull request #8 from codyjdalton/improve-docs

0.2.0: Improve documentation and update dependencies

README.md

@@ -2,17 +2,17 @@
 
 # Typescript Module Seed
 
-One Paragraph of project description goes here
+One Paragraph of project description goes here.
 
 ## Getting Started
 
 These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
 
 ### Installing
 
-A step by step series of examples that tell you have to get a development env running
+A step by step series of examples that tell you have to get a development environment running.
 
-Say what the step will be
+Say what the step will be:
 
 ```
 npm i project-name --save

lib/modules/services/some.service.spec.ts

@@ -1,5 +1,5 @@
 /**
- * some.service
+ * some.service.spec
  */
 import { expect } from 'chai';
 import { Injector } from 'super-injector';

lib/modules/some.module.ts

@@ -17,7 +17,7 @@ export class SomeModule {
     /**
      * @property {string} messageText - example text
      * Usage:
-     * this.messageTest
+     * this.messageText
      */
     private messageText: string = '';
 
@@ -27,13 +27,15 @@ export class SomeModule {
 
     /**
      * @function message (get)
+     * @return {string} - the message
      */
     get message(): string {
         return this.messageText;
     }
 
     /**
      * @function message (set)
+     * @return {void} - set the message
      */
     set message(val: string) {
         this.messageText = val;