1+ ![ Dev Build Status] ( https://img.shields.io/circleci/project/github/topcoder-platform/topcoder-react-ui-kit/develop.svg?label=develop )
2+ ![ Master Build Status] ( https://img.shields.io/circleci/project/github/topcoder-platform/topcoder-react-ui-kit/master.svg?label=master )
3+ ![ Latest NPM Release] ( https://img.shields.io/npm/v/topcoder-react-ui-kit.svg )
4+ ![ NPM Downloads] ( https://img.shields.io/npm/dm/topcoder-react-ui-kit.svg )
5+
16# Topcoder React UI Kit
27
38The [ Topcoder] ( https://www.topcoder.com ) UI Kit for internal ReactJS projects.
@@ -12,18 +17,34 @@ Import its global stylesheet into the root ReactJS component of your app:
1217``` jsx
1318import ' topcoder-react-ui-kit/dist/style.css' ;
1419```
20+ ** NOTE:** This will automatically import all
21+ [ global styles from ` topcoder-react-utils ` ] ( https://github.com/topcoder-platform/topcoder-react-utils/blob/master/docs/global-styles.md )
22+ &mdash ; no need do include those separately!
1523
1624### Global Styles
1725The import of ` topcoder-react-ui-kit/dist/style.css ` stylesheet provides you with
1826(assuming that your Webpack config properly parses that stylesheet, and bundles
1927all assets referenced from there into your bundle):
28+ - [ ** Global styles inherited from ` topcoder-react-utils ` ** ] ( https://github.com/topcoder-platform/topcoder-react-utils/blob/HEAD/docs/global-styles.md )
29+ &mdash ;
30+ [ Eric Meyer's "Reset CSS" 2.0] ( https://meyerweb.com/eric/tools/css/reset/ ) ;
31+ ` geometryPrecision ` of text rendering;
2032- [ ** ` Fonts ` ** ] ( docs/fonts.md ) &mdash ; Declaration of standard Topcoder fonts;
2133
2234### Style Mixins
2335To use any of the style mixins in your SCSS code you should import them as
2436``` scss
2537@import " ~topcoder-react-ui-kit/src/styles/mixins" ;
2638```
39+ ** NOTE:** It will automatically include all
40+ [ SCSS mixins from ` topcoder-react-utils ` ] ( https://github.com/topcoder-platform/topcoder-react-utils/blob/master/docs/scss-mixins.md )
41+ &mdash ; no need to include those separately!
42+
43+ - [ ** Mixins inherited from ` topcoder-react-utils ` ** ] ( https://github.com/topcoder-platform/topcoder-react-utils/blob/HEAD/docs/scss-mixins.md )
44+ &mdash ;
45+ [ font definition] ( https://github.com/topcoder-platform/topcoder-react-utils/blob/HEAD/docs/scss-mixins.md#font-mixins ) ,
46+ [ media conditions] ( https://github.com/topcoder-platform/topcoder-react-utils/blob/HEAD/docs/scss-mixins.md#media-mixins ) ;
47+
2748- [ ** ` Typography ` ** ] ( docs/typography-mixins.md ) &mdash ; Standard mixins for
2849 body text, fonts, headings, labels, and titles;
2950
@@ -36,10 +57,22 @@ Note that most of these components are inherited from their
3657counterparts, and ` topcoder-react-ui-kit ` just takes care about their proper
3758theming according to the TC UI Kit design specs.
3859
39- - [ ** ` Buttons ` ** ] ( docs/buttons.md ) &mdash ; Themed buttons.
60+ - [ ** ` Avatar ` ** ] ( docs/avatar.md ) &mdash ; Themed avatar;
61+ - [ ** ` Buttons ` ** ] ( docs/buttons.md ) &mdash ; Themed buttons;
62+ - [ ** ` Tags ` ** ] ( docs/tags.md ) &mdash ; Small tags for technologies, event types,
63+ etc. Technically, they are buttons styled in a different way.
4064
4165### Development
42- * To be written*
66+ To develop inside a host package just ` $ npm link ` it.
67+
68+ CI/CD with CircleCI 2.0 is set up. Commits to the protected ` master ` branch will
69+ do testing and release to NPM (be sure to properly bump the version with
70+ ` $ npm version TYPE ` , where ` TYPE ` is one of ` major ` /` minor ` /` patch ` ; and
71+ keep in mind that ` patch ` updates should never break backward compatibility;
72+ if your ` minor ` or ` major ` updates includes breaking changes, don't forget
73+ to document those in the [ CHANGELOG] ( CHANGELOG.md ) ).
74+
75+ * To be written in a better way*
4376
4477### License
4578UNLICENSED &mdash ; for internal Topcoder projects only.
0 commit comments