diff --git a/README.md b/README.md index 822bbaf..6c36b40 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,44 @@ -# brief-07-front + +# YeloBit (brief-07) +[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/) + +A brief description of what this project does and who it's for + + +## Appendix + +This a scholarship project ! + + +## API Reference + +#### Available at XXXX + +## Color Reference + +> https://ui.jln.dev/theme/7P8zdFFGSfMPUKfp + + +## Installation + +Install my-project with npm + +```bash + git clone ssh://git@git.yidhra.fr:3022/WorkSimplon/brief-07-front.git + cd brief-07-front + pnpm i +``` + +## Deployment + +To deploy this project run + +```bash + npm run deploy +``` + + +## Tech Stack + +**Client:** NextJS, TailwindCSS, RadixUi, Shadcn/ui, Axios