-
Couldn't load subscription status.
- Fork 8
chore: improve README #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
c3f7e39
Added README
drinchev 54b4d08
Fixed title.
drinchev b8ac4b7
Added Logo
drinchev 2f7c8aa
Added code coverage badge.
drinchev 5314bc7
Merge branch 'master' into chore/readme
drinchev 16e1a6c
Update README.md
drinchev 283e91a
Update README.md
drinchev d8d2bf7
Update README.md
drinchev 23c9eb8
Merge branch 'master' into chore/readme
drinchev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,52 @@ | ||
| # LIGHTELLIGENCE design system (React version) | ||
| <a href="https://lightelligence.io" align="right"> | ||
| <img src="/resources/logo.png" alt="logo" title="logo" align="right" /> | ||
| </a> | ||
|
|
||
| [User Documentation](https://developers.lightelligence.io/react) | ||
| # React | ||
|
|
||
| React components for the lightelligence platform. | ||
| [](https://travis-ci.com/lightelligence-io/react/branches) | ||
| [](https://coveralls.io/github/lightelligence-io/react) | ||
| [](https://david-dm.org/lightelligence-io/react) | ||
| [](https://www.npmjs.com/package/@lightelligence/react) | ||
|
|
||
| ## Getting Started | ||
| > The Lightelligence design system React Components | ||
|
|
||
| Install dependencies | ||
| ## Installation | ||
|
|
||
| ``` | ||
| npm install | ||
| npm install @lightelligence/react | ||
| ``` | ||
|
|
||
| Run development server on port 5050. | ||
| ## Features | ||
|
|
||
| ``` | ||
| npm run start | ||
| ``` | ||
|
|
||
| ## Running the tests | ||
| Lightelligence React is a set of React components, styled according to our | ||
| design system. It is a React.js implementation of | ||
| [Lightelligence Styles](https://github.com/lightelligence-io/styles). | ||
|
|
||
| Run unit tests | ||
| `npm run test` | ||
| ## Usage | ||
|
|
||
| ### And coding style tests | ||
| Make sure to include the bundled CSS in your React Application as well as | ||
| wrapping your content in [`<Frame />`](https://lightelligence-io.github.io/react/#/Components/Frame) | ||
| component. | ||
|
|
||
| - JavaScript/React: [airbnb coding guidelines](https://www.npmjs.com/package/eslint-config-airbnb). | ||
| - Code formatting: [prettier](https://github.com/prettier/prettier). | ||
| ```jsx | ||
| import React from 'react'; | ||
| import ReactDOM from 'react-dom'; | ||
| import '@lightelligence/react/dist/index.css'; | ||
| import { Button, Frame, COLOR_PRIMARY } from '@lightelligence/react'; | ||
|
|
||
| Please, consider installing eslint and prettier plugins for your IDE. | ||
| const App = () => ( | ||
| <Frame> | ||
| <Button color={COLOR_PRIMARY}>Hello World</Button> | ||
| </Frame> | ||
| ); | ||
|
|
||
| ### Build | ||
|
|
||
| Build all project parts by using node scripts. | ||
|
|
||
| ## Built With | ||
| ReactDOM.render(<App />, document.getElementById('root')); | ||
| ``` | ||
|
|
||
| - [react](https://reactjs.org/) | ||
| - [LIGHTELLIGENCE CSS styleguide](https://github.com/lightelligence-io/styles) The CSS implementation of the lightelligence design-system | ||
| Check out [the API reference](https://lightelligence-io.github.io/react/) | ||
| to see the full documentation. | ||
|
|
||
| ## Contributing | ||
| ## License | ||
|
|
||
| ## Acknowledgments | ||
| MIT | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.