feat: Update README file extensively
The README file has been greatly expanded, providing a comprehensive documentation for the project. Details include a brief description, appendix note, API references, color references, installation guidelines, deployment instructions and listing of tech stack being used.
This commit is contained in:
parent
3d8a1ab677
commit
b62e51af70
44
README.md
44
README.md
@ -1,2 +1,44 @@
|
|||||||
# brief-07-front
|
|
||||||
|
# YeloBit (brief-07)
|
||||||
|
[](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
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user