[core] Add Readme

Wurielle · Mar 10, 2021 · 631efdc · 631efdc
1 parent c2d55f8
commit 631efdc
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,43 @@
-# mantine
-Mantine Components Monorepo
+# Mantine
+
+![Github banner](./github-banner.svg)
+
+Build better React applications. Mantine is a customizable component library with focus on accessibility and developer experience.
+
+## Links
+
+- [Documentation](https://mantine.dev/)
+- [Getting Started](https://mantine.dev/getting-started/)
+- [Examples](https://mantine.dev/examples/)
+- [Contributing](https://mantine.dev/source/)
+
+## Installation
+
+To start using Mantine you need to install [`@mantine/core`](https://www.npmjs.com/package/@mantine/core) and its peer dependencies:
+
+```sh
+# With yarn
+yarn add @mantine/core @mantine/hooks react-jss @modulz/radix-icons
+
+# With npm
+yarn add @mantine/core @mantine/hooks react-jss @modulz/radix-icons
+
+# With install-peerdeps
+npx install-peerdeps @mantine/core
+```
+
+## Usage
+
+Now you can import and use any component from @mantine/core:
+
+```tsx
+import { Button } from '@mantine/core';
+
+function App() {
+  return <Button>Mantine button</Button>;
+}
+```
+
+## Licence
+
+All @mantine/ scoped packages, dependencies and peer dependencies have MIT licence.
diff --git a/github-banner.svg b/github-banner.svg