From 32258694316da5bf4974904177993d4839d782f5 Mon Sep 17 00:00:00 2001 From: doryan04 Date: Tue, 30 Jan 2024 01:02:42 +0400 Subject: [PATCH] UPDATE: README.md --- README.md | 70 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 45 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index b8ab8dc..0504f08 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,45 @@ -# Next.js + Turbopack - -This example allows you to get started with `next dev --turbo` quicky. - -## Deploy your own - -[![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) - -## How to use - -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: - -```bash -npx create-next-app --example with-turbopack with-turbopack-app -``` - -```bash -yarn create next-app --example with-turbopack with-turbopack-app -``` - -```bash -pnpm create next-app --example with-turbopack with-turbopack-app -``` - -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)). +# React/Next.js Material You UI kit (pre-alpha) +--- +This repository is including and will be including components, enumerates in table: +- [x] Buttons + - [x] Default + - [x] Icon + - [x] FAB + - [x] Radio + - [ ] Segmented +- [x] Checkbox +- [x] Text fields +- [x] Switches +- [ ] Chips +- [x] Ripple Effect +- [x] Dividers +- [x] Badges +- [ ] Select field +- [ ] Bottom sheets +- [ ] Cards +- [ ] Menus +- [ ] Navigation + - [ ] Bars + - [ ] Drawer + - [ ] Rail +- [ ] 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) \ No newline at end of file