Merge pull request #36 from nitin42/3.x.x

3.5.x

Author: jcgertig

.hound.yml

@@ -1,4 +1,6 @@
+jslint:
+  enabled: false
 eslint:
-  enabled: true
+  enabled: false
   config_file: .eslintrc
   ignore_file: .eslintignore

.storybook/config.js

@@ -0,0 +1,7 @@
+import { configure } from '@storybook/react';
+
+function loadStories() {
+  require('../stories');
+}
+
+configure(loadStories, module);

.storybook/webpack.config.js

@@ -0,0 +1,18 @@
+// you can use this file to add your custom webpack plugins, loaders and anything you like.
+// This is just the basic way to add additional webpack configurations.
+// For more information refer the docs: https://storybook.js.org/configurations/custom-webpack-config
+
+// IMPORTANT
+// When you add this file, we won't add the default configurations which is similar
+// to "React Create App". This only has babel loader to load JavaScript.
+
+module.exports = {
+  plugins: [
+    // your custom plugins
+  ],
+  module: {
+    loaders: [
+      // add your custom loaders.
+    ],
+  },
+};

CONTRIBUTING.md

@@ -9,6 +9,9 @@ I'm excited to have you helping out. Thank you so much for your time.
 Considering you've forked and cloned the repo on your system, switch to the directory and install the dependencies.
 
 ```
+npm install g babel-cli
+npm install g webpack-cli
+
 cd terminal-in-react
 npm install
 ```
@@ -24,12 +27,10 @@ npm install
 
 ### Starting development server
 
-To test your changes, there is a [starter](./starter) folder where you will find two files, `index.html` and `App.js`. 
+To test your changes [Storybook](https://storybook.js.org) is used. This is a neat tool to test your component in an isolated state.
 
-Make your changes to `App.js` and start the development server with -
+To start it, simply run `npm run storybook` and head to [http://localhost:6006]().
 
-```
-npm run start
-```
+To add a new use case, just add a new story in the `stories/index.js` file.
 
 That's it! I am excited to see your pull request.

README.md

@@ -20,8 +20,6 @@
 
 * [Usage](#usage)
 
-* [Styling](#include-the-css)
-
 * [Working](#working)
 
 * [Plugins](#using-plugins-)
@@ -61,7 +59,6 @@ yarn add terminal-in-react
 ```jsx
 import React, { Component } from 'react';
 import Terminal from 'terminal-in-react';
-import 'terminal-in-react/lib/css/index.css';
 
 class App extends Component {
   showMsg = () => 'Hello World'
@@ -98,9 +95,6 @@ class App extends Component {
   }
 }
 ```
-#### Include the CSS
-
-Ensure that `terminal-in-react/lib/css/index.css` is loaded
 
 > Be careful when copying this example because it uses `window` object (`'open-google': () => window.open("https://www.google.com/", "_blank"),`) which is only available on the client-side and it will give you an error if you're doing server side rendering.
 
@@ -461,19 +455,10 @@ Eject from `create-react-app` and use a custom webpack configuration with [`babi
 
 Set the style to `height: 100vh` on parent element.
 
-**Interface issues due to plugins**
-
-If you are having any issues with **plugins** or related api, fallback to `3.3.3`. Because plugins are still **WIP** !
-
 [npm-dm]: https://img.shields.io/npm/dm/terminal-in-react.svg
 [npm-dt]: https://img.shields.io/npm/dt/terminal-in-react.svg
 [npm-v]: https://img.shields.io/npm/v/terminal-in-react.svg
 [deps]: https://img.shields.io/david/nitin42/terminal-in-react.svg
 [dev-deps]: https://img.shields.io/david/dev/nitin42/terminal-in-react.svg
 [license]: https://img.shields.io/npm/l/terminal-in-react.svg
 [package-url]: https://npmjs.com/package/terminal-in-react
-
-## New updates
-
-Follow [@NTulswani](https://twitter.com/NTulswani) on Twitter for new updates and progress 😄
-