bdash

:eyeglasses: The internal CSS toolkit and guideline of SIROK, Inc.

About | Install | Usage | Documentation | Updating

About

The bdash is a CSS toolkit of SIROK, Inc. It is very inspired by Primer by GitHub. Our aims to make our development be fast and maintainable.

:sparkles: We love Open Source :v:. we are always welcome your suggestion but it is our internal CSS toolkit. we will not add new features we do not use in our products but we think seriously about your suggesiton. If your suggesiton is considering exsisting code, it will be better. Thanks in advance. Lean more about CONTRIBUTING.

Install

bower

$ bower install bdash --save-dev

npm

$ npm install bdash --save-dev

Usage

Stylus

Import files in your project using @import without the extension below:

// Example: All files
@import "bdash/stylus/bdash"

// Example: Individual file
@import "bdash/stylus/_sanitize"
@import "bdash/stylus/_base"
@import "bdash/stylus/_buttons"

CSS

Specify relationships between the current document and CSS below:

<link rel="stylesheet" href="dist/bdash.min.css" type="text/css">

Documentation

We write documentation on Wiki. It include style coding guide, the way to develop and so on. Documentation in Wiki is written in Japanese because it is for people at SIROK, Inc.

Updating

Update all dependencies:

$ bower update

Contributing

If you have any question or suggestion, please feel free to create issues or pull request. When you create issues or pull request, please read Contributing before.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, IT is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.

License

MIT © SIROK, Inc.

Whenever code for bdash is borrowed or inspired by awesome existing sources, we credit the original developer, designer or article in our code. Please create issues if you think any credit is absent.