UPDATE: README.md

README.md

@@ -1,25 +1,45 @@
-# Next.js + Turbopack
+# React/Next.js Material You UI kit (pre-alpha)
-
+---
-This example allows you to get started with `next dev --turbo` quicky.
+This repository is including and will be including components, enumerates in table:
-
+- [x] Buttons
-## Deploy your own
+    - [x] Default
-
+    - [x] Icon
-[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-turbopack&project-name=with-turbopack&repository-name=with-turbopack)
+    - [x] FAB
-
+    - [x] Radio
-## How to use
+    - [ ] Segmented
-
+- [x] Checkbox
-Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
+- [x] Text fields
-
+- [x] Switches
-```bash
+- [ ] Chips
-npx create-next-app --example with-turbopack with-turbopack-app
+- [x] Ripple Effect
-```
+- [x] Dividers
-
+- [x] Badges
-```bash
+- [ ] Select field
-yarn create next-app --example with-turbopack with-turbopack-app
+- [ ] Bottom sheets
-```
+- [ ] Cards
-
+- [ ] Menus
-```bash
+- [ ] Navigation
-pnpm create next-app --example with-turbopack with-turbopack-app
+    - [ ] Bars
-```
+    - [ ] Drawer
-
+    - [ ] Rail
-Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
+- [ ] Sliders
+- [ ] Snackbar
+- [ ] Tabs
+- [ ] Bottom sheets
+- [ ] Bottom app bars
+  ~~and including preview page for test.~~
+  Preview page on stage WIP.
+# Status
+---
+Nowadays, this UI kit have base kinds of components and you could make everything. For example - general forms (without select field and etc.)
+# Roadmap
+---
+1. Full implementation components;
+2. Release NPM package;
+3. Custom theaming.
+---
+## Did you find the bug? Make sure to [leave an issue](https://github.com/doryan04/DSS/issues/new) in case of any problems.
+---
+## If you want help to the project, please, advise your idea in Pull request and don't forget [send issue](https://github.com/doryan04/DSS/issues/new)
+---
+### Check out actual news on Telegram. [https://t.me/doryanProjects](https://t.me/doryanProjects)