Skip to content

Commit

Permalink
[core] Add badges to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rtivital committed Oct 6, 2021
1 parent 9bac93b commit 5abc5cb
Showing 1 changed file with 16 additions and 24 deletions.
40 changes: 16 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,32 @@
![Github](https://github.com/mantinedev/mantine/blob/master/.demo/Github.png?raw=true)
# Mantine

[![NPM](https://img.shields.io/npm/l/@mantine/core)](https://github.com/mantinedev/mantine/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/mantinedev/mantine)](https://github.com/mantinedev/mantine/graphs/contributors)
[![npm](https://img.shields.io/npm/v/@mantine/core)](https://www.npmjs.com/package/@mantine/core)
[![npm](https://img.shields.io/npm/dm/@mantine/hooks)](https://www.npmjs.com/package/@mantine/hooks)
[![Help wanted](https://img.shields.io/github/labels/mantinedev/mantine/help%20wanted?label=Contribute)](https://github.com/mantinedev/mantine/labels/help%20wanted)
[![Discord](https://img.shields.io/badge/Chat%20on-Discord-%235865f2)](https://discord.gg/eUZpPbpxb4)
[![Twitter Follow](https://img.shields.io/twitter/follow/mantinedev?style=social)](https://twitter.com/mantinedev)

Mantine is a MIT licensed open source react components and hooks library with focus on usability, accessibility and developer experience.

## Links

- [Documentation](https://mantine.dev/)
- [Core components by category](https://mantine.dev/core/getting-started/)
- [Hooks list](https://mantine.dev/hooks/getting-started/#included-hooks)
- [Notifications system](https://mantine.dev/others/notifications/)
- [Contributing](https://mantine.dev/contribute/)
- [Contributing](https://mantine.dev/pages/contributing/)
- [Ask question or give feedback](https://github.com/mantinedev/mantine/discussions)
- [Changelog](https://mantine.dev/pages/changelog/)
- [Sign up for monthly newsletter](https://buttondown.email/mantine)
- [Follow Mantine on Twitter](https://twitter.com/mantinedev)
- [Follow on Twitter](https://twitter.com/mantinedev)
- [Join Discord community](https://discord.gg/eUZpPbpxb4)

## Features

- **Customization** – colors, fonts, shadows and many other parts are customizable to fit your design needs
- **Flexibility** – configure components appearance and behavior with vast amount of settings or overwrite any part of component styles
- **Dark theme** – mantine supports dark theme by default in all components
- **Accessibility and usability** – all components follow accessibility best practices and feature full keyboard support
- **TypeScript** – all @mantine/ scoped packages are built with TypeScript and support it by default
- **Ready for production** – mantine is well tested and works in all modern browsers
- **Developer experience** – mantine comes with more than 50 components and 15 hooks to cover you in most cases
- **No annoying focus ring** – with new :focus-visible pseudo-class focus ring appears only when user navigates with keyboard
- **React and Preact** – mantine works flawlessly with preact

## Licence

All Mantine packages have MIT licence. All Mantine dependencies also have MIT licence.

## Contributors

<a href="https://github.com/mantinedev/mantine/graphs/contributors">
<img src="https://contrib.rocks/image?repo=mantinedev/mantine" />
</a>

[Become a contributor](https://mantine.dev/contribute/)
[Become a contributor](https://mantine.dev/pages/contributing/)

## Licence

MIT

0 comments on commit 5abc5cb

Please sign in to comment.