[core] Update README and add CONTRIBUTING

Wurielle · Apr 16, 2021 · aa67bc5 · aa67bc5
1 parent 1284e8c
commit aa67bc5
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,3 @@
+# Contributing
+
+Please read contributions guideline on [mantine website](https://mantine.dev/pages/contribute/)
diff --git a/README.md b/README.md
@@ -1,28 +1,25 @@
-# Mantine
-
 ![Github banner](./github-banner.svg)
 
-Build better React applications. Mantine is a customizable component library with focus on accessibility and developer experience.
+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/)
+- [Getting Started](https://mantine.dev/)
+- [Examples](https://mantine.dev/pages/examples/)
+- [Contributing](https://mantine.dev/pages/contribute/)
 
 ## 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
+yarn add react-jss @mantine/theme @mantine/hooks @mantine/core
 
 # With npm
-yarn add @mantine/core @mantine/hooks react-jss
+npm install react-jss @mantine/theme @mantine/hooks @mantine/core
 
-# With install-peerdeps
+# With peerdeps
 npx install-peerdeps @mantine/core
 ```
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Contributing

		Please read contributions guideline on [mantine website](https://mantine.dev/pages/contribute/)