Add GitBook config

pburtchaell · Jun 27, 2018 · 135376b · 135376b
1 parent 1f86362
commit 135376b
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 20 deletions.
diff --git a/.gitbook.yml b/.gitbook.yml
@@ -0,0 +1,3 @@
+structure:
+  readme: README.md
+  summary: docs/README.md
diff --git a/README.md b/README.md
@@ -1,18 +1,23 @@
 # React Notification
+[![Build Status](https://travis-ci.org/pburtchaell/react-notification.svg)](https://travis-ci.org/pburtchaell/react-notification) [![npm downloads](https://img.shields.io/npm/dm/react-notification.svg?style=flat)](http://badge.fury.io/js/react-notification)
 
-[![npm version](https://badge.fury.io/js/react-notification.svg)](http://badge.fury.io/js/react-notification) [![Build Status](https://travis-ci.org/pburtchaell/react-notification.svg)](https://travis-ci.org/pburtchaell/react-notification) [![npm downloads](https://img.shields.io/npm/dm/react-notification.svg?style=flat)](http://badge.fury.io/js/react-notification)
-
-![](https://raw.githubusercontent.com/pburtchaell/react-notification/master/docs/example-b.gif)
-
-React Notification is a component designed to provide snackbar notification messages and notification stacks. The default visual style and interaction follows [Material Design guidelines for snackbars](http://www.google.com/design/spec/components/snackbars-toasts.html#snackbars-toasts-usage), but it can be fully customized.
+React Notification provides snackbar notification messages and notification stacks. The default visual style and interaction follows [Material Design guidelines for snackbars](http://www.google.com/design/spec/components/snackbars-toasts.html#snackbars-toasts-usage) and can be fully customized.
 
 ## Documentation and Help
-
 - [Guides](/docs/guides/)
 - [Introduction](/docs/introduction.md)
 - [Examples](/examples)
+
+## Releases
 - [Releases](https://github.com/pburtchaell/react-notification/releases)
 - [Upgrading versions](/UPGRADING.md)
 
----
-Copyright (c) 2015-2018 Patrick Burtchaell. [Licensed with The MIT License (MIT)](https://raw.githubusercontent.com/pburtchaell/react-notification/master/LICENSE).
+## Maintainers
+- [Patrick Burtchaell](http://github.com/pburtchaell)
+- [Berkeley Martinez](https://github.com/BerkeleyTrue)
+- [Joey Figaro](https://github.com/joeyfigaro)
+
+## License
+Copyright (c) 2015-2018 Patrick Burtchaell. 
+
+[Licensed with The MIT License (MIT)](https://raw.githubusercontent.com/pburtchaell/react-notification/master/LICENSE).
diff --git a/docs/example-a.gif b/docs/example-a.gif
diff --git a/docs/example-b.gif b/docs/example-b.gif
diff --git a/docs/guides/styles.md b/docs/guides/styles.md
@@ -1,6 +1,6 @@
 ## Styles
 
-This component uses basic inline CSS to style the position and visibility of the notification. I would suggest reading the usage guidelines for [snackbars](http://www.google.com/design/spec/components/snackbars-toasts.html) before making any changes.
+This component uses basic inline styles to style the position and visibility of the notification. I would suggest reading the usage guidelines for [snackbars](http://www.google.com/design/spec/components/snackbars-toasts.html) before making any changes.
 
 You have two options for adding additional styles:
 

diff --git a/docs/introduction.md b/docs/introduction.md
@@ -1,9 +1,5 @@
 ## Introduction
 
-First, install the component via npm: `npm install react-notification`.
-
-Note the component uses `Object.assign`. If you are compiling with Babel, you should include the Babel Polyfill in your build to ensure the method works.
-
 ### For single notification component
 
 ```js
@@ -62,10 +58,3 @@ render () {
   );
 }
 ```
-
-## Sponsor
-
-**Individual**: If you like this code and you're interested in buying me a drink, I have a [Gratipay](https://gratipay.com/~pburtchaell/) (recurring) or [Venmo](https://venmo.com/pburtchaell) (one time). I greatly appreciate your support and I'm grateful to be a part of the open source and GitHub communities.
-
-**Company**: To help cover the cost of my time spent maintaining open source software projects, I'm looking for a small sponsor. If your company is interested, [email me](mailto:patrick@pburtchaell.com) and we can chat! 
-