implement new class approach

README.md

@@ -1,5 +1,5 @@
 # smartgit
-wrapper for git.
+smart git wrapper for node.
 
 smartgit expects git to be installed on target machine.
 
@@ -19,22 +19,48 @@ smartgit expects git to be installed on target machine.
 [![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
 [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
-## Features:
-
-* clone a git repo
-* init a new repo
-* create a new git repo
-* add changes and make a new commit
-* commit changes
-* push changes
-* add/remove remotes
-
 ## Usage
 We recommend the use of TypeScript for best in class intellisense
 
 ```javascript
-import * as smartgit from 'smartgit'
+// import smartgit:
+import { GitRepo } from 'smartgit'
 
+// Initialize smartgit:
+// -- note: there are 3 ways to initialize smartgit
+// -- -- 1. with a existing Git repo
+// -- -- 2. with a cloned Git repo
+// -- -- 3. with a new Git repo
+
+// -- 1. existing Git Repo:
+let myExistingGitRepo = new GitRepo('/path/to/existing/git/repo/')
+
+// -- 2. cloned Git Repo:
+let myClonedGitRepo: GitRepo
+smartgit.createRepoFromClone('git@github.com:username/reponame.git')
+    .then(gitRepo => { // non blocking
+        myClonedGitRepo = gitRepo
+    })
+
+// -- 3. new Git Repo
+let myNewGitRepo: GitRepo
+smartgit.createRepoFromInit('/path/to/new/folder') // smartgit will create any new folder, be careful
+    .then(gitRepo => { // non blocking
+        myNewGitRepo = gitRepo
+    })
+
+// Using smartgit instance
+// -- most used actions
+// -- all actions return promises, so make sure to use promise chaining for any dependent tasks
+myExistingGitRepo.addAll() // returns promise, stages all changed files
+myExistingGitRepo.add(['relative/path/to/file.txt','another/file2.txt']) // returns promise, stages specific files
+myExistingGitRepo.commit('my commit message') // returns promise, commits staged files
+myExistingGitRepo.status() // returns promise
+    .then(status => { // Use TypeScript for status type information
+
+    })
+myExistingGitRepo.check() // returns promise, checks repo health
+myExistingGitRepo.remoteAdd('git@github.com:username/reponame.git')
 ```
 
 Tip: use [smartssh](https://npmjs.com/smartssh) to setup your SSH environment