Skip to content
This repository has been archived by the owner on Jan 25, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bclark-p44 authored Jul 27, 2022
1 parent 5f188e8 commit cb399b5
Showing 1 changed file with 2 additions and 53 deletions.
55 changes: 2 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,57 +4,6 @@

Themeable design system built using [Emotion] and [Radix] for project44.

## Documentation
## [Deprecated] This project is no longer in active development.

Our documentation site lives at [p44design.systems]. You'll be able to find detailed documentation on getting started, all of the components, our theme, our principles, and more.

## Installation

Install `@manifest-ui/react` and necessary peer dependencies in your project with your package manager of choice:

```sh
# with npm
npm install @manifest-ui/react

# with yarn
yarn add @manifest-ui/react
```

All Manifest UI packages can be found on [NPM].

## Usage

To start using the theme and components, please follow these steps:

Wrap your application with the `Provider` provided by **@manifest-ui/react**.

```jsx
import { Provider } from '@manifest-ui/react';

// Do this at the root of your application
function App({ children }) {
return <Provider>{children}</Provider>;
}
```

Now you can start using components like so:

```jsx
import { Button } from '@manifest-ui/react';

function Example() {
return <Button>Track shipment</Button>;
}
```

## Contributing

We love collaborating with folks inside and outside of project44 and welcome contributions!

> 👉 See the [contributing docs] for more info on code style, testing, coverage, and troubleshooting
[p44design.systems]: https://p44design.systems
[emotion]: https://emotion.sh/docs/introduction
[radix]: https://www.radix-ui.com/
[contributing docs]: CONTRIBUTING.md
[NPM]: https://www.npmjs.com/search?q=%40manifest-ui
For all development work related to the Manifest Design System, please visit: https://github.com/project44/manifest

0 comments on commit cb399b5

Please sign in to comment.