Feat/add typings #56 (#57)

README.md

@@ -174,15 +174,24 @@ However, there is a little difference between module usage and CLI of the `scrip
 
 ```js
 releaseNotes({
-	branch: 'master',
-	script: (data, callback) => {
-		callback({
-			foo: 'bar'
-		})
-	}
+  branch: 'master',
+  script: (data, callback) => {
+    callback({
+      foo: 'bar'
+    })
+  }
 }, RANGE, TEMPLATE)
 ```
 
+### Typescript
+
+`git-release-notes` includes [Typescript](http://www.typescriptlang.org/) definitions.
+
+```ts
+import * as releaseNotes from "git-release-notes";
+releaseNotes({ path }, range, TEMPLATE);
+```
+
 
 ### Debug
 If your post processing script or template throws an exception, the JSON data will be written to the file system in the same folder as the processing script.

index.d.ts

@@ -0,0 +1,47 @@
+export = gitReleaseNotes;
+
+interface ICommit {
+	sha1: string;
+	authorName: string;
+	authorEmail: string;
+	authorDate: string;
+	committerName: string;
+	committerEmail: string;
+	committerDate: string;
+	title: string;
+	tag: string;
+	messageLines: string[];
+}
+type postprocessingFn = (data: {
+	commits: ICommit[];
+	range: string;
+	dateFnsFormat: (data: string | number | Date, format?: string, options?: {
+		locale?: any;
+	}) => string;
+	debug: any;
+}, callback: (data: any) => void) => void;
+
+declare function gitReleaseNotes(options: {
+	p?: string;
+	path?: string;
+	b?: string;
+	branch?: string;
+	i?: string;
+	"ignore-case"?: string;
+	s?: postprocessingFn | string;
+	script?: postprocessingFn | string;
+	t?: string;
+	title?: string;
+	f?: string;
+	file?: string;
+	c?: boolean;
+	"merge-commits"?: boolean;
+	o?: string[] | string;
+	"gitlog-option"?: string[] | string;
+	m?: string[] | string;
+	meaning?: string[] | string;
+}, range: string, template: string): Promise<string>
+
+declare namespace gitReleaseNotes {
+
+}

package.json

@@ -2,6 +2,7 @@
   "author": "ariatemplates <[email protected]> (http://github.com/ariatemplates)",
   "name": "git-release-notes",
   "description": "Generate beautiful release notes from a git log.",
+  "typings": "./index.d.ts",
   "keywords": [
     "git",
     "log",