@narmi/design_system 2.10.0 → 2.11.2

package/LICENSE.md

@@ -7,4 +7,3 @@ The above copyright notice and this permission notice shall be included in all c
 The rights granted above may only be exercised to develop and distribute applications that integrate or interoperate with Narmi software or services, and in the case of external, stand-alone applications that do not embed directly inside Narmi, the rights granted above may only be exercised to develop and distribute applications that are dissimilar and visually distinct from Narmi products and services (including the internal administration page(s) of Narmi banking products), as determined by Narmi in its sole discretion.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

package/README.md

@@ -11,6 +11,7 @@ custom experiences in combination with the [Narmi API](https://www.narmi.com/dev
 ## Getting started
 
 ### Installation
+
 Narmi Design System is published as a single NPM package.
 
 ```
@@ -18,6 +19,7 @@ npm install @narmi/design_system --save
 ```
 
 #### Peer dependencies
+
 Your project must provide the following packages as peer dependencies:
 
 - React (>=16.9, supports Hooks)
@@ -26,12 +28,12 @@ Your project must provide the following packages as peer dependencies:
 
 - 📖 [Storybook (latest)](https://narmi.github.io/design_system/)
 - 🎨 [Design Guidelines](https://zeroheight.com/8ac87d4ba/p/446c38-narmi-design-system-nds)
-- ✏️  [Contributing](https://github.com/narmi/design_system/blob/master/CONTRIBUTING.md)
-
+- ✏️ [Contributing](https://github.com/narmi/design_system/blob/master/CONTRIBUTING.md)
 
 ## Usage
 
 ### Components
+
 Components can be imported from package root:
 
 ```
@@ -39,6 +41,7 @@ import { Button, Tooltip } from '@narmi/design_system';
 ```
 
 ### Style Helpers
+
 NDS provides a set of global CSS helper classes to make it easy to tweak
 styling in your markup with standard Narmi design values. For example:
 
@@ -53,6 +56,7 @@ styling in your markup with standard Narmi design values. For example:
 For full documentation of available classes, see [storybook docs](https://narmi.github.io/design_system/).
 
 ### Design tokens
+
 All available distributions of design tokens can be found in `dist/tokens`.
 All CSS custom properites from design tokens are already included in the base
 stylesheet, `dist/style.css`.
@@ -60,53 +64,59 @@ stylesheet, `dist/style.css`.
 To request a new distribution, please [file an issue](https://github.com/narmi/design_system/issues/new/choose).
 
 ### Versioning
+
 This project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 Refer to the [**Changelog**](https://github.com/narmi/design_system/blob/master/CHANGELOG.md) for details.
 
 ### Browser Support
+
 See [`.browserslistrc`](https://github.com/narmi/design_system/blob/master/.editorconfig) for officially supported browsers or
 run `npx browserslist` in this project locally to see a full list of targeted browsers.
 
 This project does not support any version of Internet Explorer.
 
-
 ## Contributing
 
 ### Local development
-To run storybook locally:
+
+To run project locally:
 
 ```
 git clone git@github.com:narmi/design_system.git
 cd design_system
-npm install && npm run build && npm run storybook
+npm run dev
 ```
 
 ### NPM scripts
 
-`npm run` command    | Description
--------------------- | ---------------------------------------
-`build:jsdoc`        | builds jsDoc documentation to `dist/`
-`build:tokens`       | builds all distributions of design tokens to `dist/`
-`build:components`   | builds all components and base stylesheet to `dist/`
-`build`              | builds everytyhing
-`test`               | runs all jest tests
-`storybook`          | starts storybook in dev server mode on `:6006`
-`watch`              | watches `src` dir, triggering `build` on changes
+| `npm run` command  | Description                                          |
+| ------------------ | ---------------------------------------------------- |
+| `build:jsdoc`      | builds jsDoc documentation to `dist/`                |
+| `build:tokens`     | builds all distributions of design tokens to `dist/` |
+| `build:components` | builds all components and base stylesheet to `dist/` |
+| `build`            | builds everytyhing                                   |
+| `test`             | runs all jest tests                                  |
+| `storybook`        | starts storybook in dev server mode on `:6006`       |
+| `watch`            | watches `src` dir, triggering `build` on changes     |
+| `dev`              | **Start storybook and watch for all `src` changes**  |
 
 ### Releases
+
 This project uses [`semantic-release`](https://semantic-release.gitbook.io/semantic-release/),
- configured to use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+configured to use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
 
 Any time new commits are added to the `master` branch, the GitHub Action "release" will run `semantic-release`. The job will
 parse recent git tags and commit messages to determine the new version number, tag the release, publish to NPM, and update the changelog.
 
 #### Major releases
+
 All PRs target `master` unless it contains breaking changes. Any branch continaing breaking change commits should target the open major release branch.
 For example, if NDS is on major version `1`, breaking changes should target the branch `major/v2`.
 
 Branches containing breaking change commits should follow the naming convention `breaking/<branch name>`.
 
 ### Commit Guidelines
+
 This project requires structured commit messages in the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format:
 
 ```
@@ -120,16 +130,19 @@ Adding a bang (`!`) to the commit type denotes a breaking change ([see docs](htt
 #### Examples
 
 Making a fix without scope specified:
+
 ```
 fix: update global `text-rendering` value
 ```
 
 Adding a feature within the scope of the Button component:
+
 ```
 feat(Button): add secondary button variant
 ```
 
 Breaking change within the Button component scope:
+
 ```
 refactor(Button)!: remove variant `disabled`. The `disabled` boolean prop is now used to disable a button.
 ```
@@ -148,4 +161,3 @@ If you are making a breaking change, please [note it in your commit message](htt
 ## License
 
 Source code is under a custom license based on MIT. The license restricts `@narmi/design_system` usage to applications that integrate or interoperate with Narmi software or services, with additional restrictions for external, stand-alone applications. Please see LICENSE.md for full details.
-