Skip to content
This repository has been archived by the owner on Jul 17, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mazipan authored May 15, 2017
1 parent 78c0434 commit d943b6e
Showing 1 changed file with 8 additions and 64 deletions.
72 changes: 8 additions & 64 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,73 +23,17 @@ https://mazipan.github.io/bem-kit/
- You can partialy import from our available component.
- Full SASS modular code.

## Download
## Downloads
https://github.com/mazipan/bem-kit/wiki/Downloads

#### npm
[![npmjs](https://img.shields.io/badge/download-npmjs-red.svg?maxAge=3600)](https://www.npmjs.com/package/bem-kit)
```
npm install bem-kit --save
```
#### yarn
[![yarnpkg](https://img.shields.io/badge/download-yarn-blue.svg?maxAge=3600)](https://yarnpkg.com/en/package/bem-kit)
```
yarn add bem-kit
```
#### ZIP
https://github.com/mazipan/bem-kit/releases
## How to use
https://github.com/mazipan/bem-kit/wiki/How-to-use

#### CDN
https://mazipan.github.io/bem-kit/dist/bem-kit.min.css
## Supported Components
https://github.com/mazipan/bem-kit/wiki/Supported-Components

## Demo And Cheatsheet
https://mazipan.github.io/bem-kit/demo/

## Usage

### Using CSS Native :
```html
<link rel="stylesheet" href="{URL_PATH}/css/bem-kit.min.css" rel="stylesheet"/>
```

### Using SASS Import :
```scss
// if you want import all classes
@import "./bem-kit/src/bem-kit.scss";


// if you want import RULES only without classes
@import "./bem-kit/src/_bem-kit";
```

### Added Javascript Functionality (Optional)
```html
<script type="text/javascript" src="{URL_PATH}/js/jquery.min.js"></script>
<script type="text/javascript" src="{URL_PATH}/js/bem-kit.min.js"></script>
```

## Supported Component (in alphabetical order)</h3>
- alert
- button (basic, outline, radius, dropdown)
- card
- checkbox (black and blue theme)
- form
- grid system (traditional grid and flex)
- modal (white and blue theme)
- pagination (basic and radius)
- popover (dark theme)
- radio (black and blue theme)
- select
- table (support sort arrow view)
- tabs (horizontal and vertical)
- textfield (basic for input text and textarea)

## Using Technology</h3>
- SASS
- HTML
- NodeJS, Gulp, etc.

## License
MIT License
## Cheatsheets
https://github.com/mazipan/bem-kit/wiki/Cheatsheets


Hope will usefull for you all.
Expand Down

0 comments on commit d943b6e

Please sign in to comment.