[![ci-cd](https://github.com/transferwise/neptune-web/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/transferwise/neptune-web/actions) [![NPM](https://badge.fury.io/js/%40transferwise%2Fneptune-css.svg)](https://www.npmjs.com/package/@transferwise/neptune-css)

# Neptune Web CSS

Neptune is the Design System built by and used at Wise. Neptune Web is the Neptune framework for Web. Neptune Web provides a way to build high quality, consistent user experiences on the web with ease.

This is the Neptune Web CSS library. It works well with [Neptune React Components](https://github.com/transferwise/neptune-web/tree/main/packages/components).

## Usage

Neptune CSS is published to npm as [@transferwise/neptune-css](https://www.npmjs.com/package/@transferwise/neptune-css).

Install `@transferwise/neptune-css`:

```
# pnpm
pnpm add @transferwise/neptune-css

# yarn
yarn add @transferwise/neptune-css

# npm
npm install @transferwise/neptune-css
```

There are three bundles to choose from, depending on your needs:

```js
// Everything
import '@transferwise/neptune-css/dist/css/neptune.css';

// Core
import '@transferwise/neptune-css/dist/css/neptune-core.css';

// Addons
import '@transferwise/neptune-css/dist/css/neptune-addons.css';
```

## Documentation

Visit the [docs](https://transferwise.github.io/neptune-web) for information on getting started and documentation on what is included in each bundle.

## Contributing

We love contribution! 🙏 Read [the guide](https://github.com/transferwise/neptune-web/blob/main/packages/css/CONTRIBUTING.md) to get started.
