diff --git a/README.md b/README.md index d2b4a44..9eab85f 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,12 @@ # ract-tiny-tabs -The package is based on [npm-base](https://github.com/kadirahq/npm-base) package by [Kadira](https://github.com/kadirahq) which is really great when you want to prepare Npm package. This one is prepared to be used as a starter point for React components which needs to be published on Npm. +Easy to use React tab component that lets you choose from 3 themes, customize colors for text and background, use double lines in the title, wrap bottom content to match the nav width, nest tabs inside other tabs, define transition speed or use the navigation in the bottom. -It includes linting with [ESLint](http://eslint.org/) and testing with [Mocha](https://mochajs.org/), [Enzyme](http://airbnb.io/enzyme/) and [JSDOM](https://github.com/tmpvar/jsdom). - -Also there is of course ES6 transpilation. +See the live [DEMO:](nashio.github.com/tiny-tabs) ## Usage -1. Clone this repo -2. Inside cloned repo run `npm install && rm -rf .git && git init` and update `package.json` with your package name. -3. If you want to run tests: `npm test` or `npm run testonly` or `npm run test-watch`. You need to write tests in `__tests__` folder. You need at least Node 4 on your machine to run tests. -4. If you want to run linting: `npm test` or `npm run lint`. Fix bugs: `npm run lint-fix`. You can adjust your `.eslintrc` config file. -5. If you want to run transpilation to ES5 in `dist` folder: `npm run prepublish` (standard npm hook). - -## CSS and preprocessors - -For more information check out this thread: [#5](https://github.com/juliancwirko/react-npm-boilerplate/issues/5) - -## Blog post about it: - -- [Creating React NPM packages with ES2015](http://julian.io/creating-react-npm-packages-with-es2015/) - -## Also check out -- [React Alert UI component](https://github.com/juliancwirko/react-s-alert) -- [React project boilerplate with Webpack, HMR, React Router](https://github.com/juliancwirko/react-boilerplate) ## License diff --git a/examples/basic/index.js b/examples/basic/index.js index 711ec99..88124d1 100644 --- a/examples/basic/index.js +++ b/examples/basic/index.js @@ -14,6 +14,8 @@ const settings = { }; /* Examples */ + +// default theme, fade between tabs const TabsDemo1 = () => (