diff --git a/README.md b/README.md new file mode 100644 index 0000000..6aede73 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# Project Name + +A brief description of what your project does. + +## Table of Contents + +- [Project Name](#project-name) + - [Table of Contents](#table-of-contents) + - [Getting Started](#getting-started) + - [Prerequisites](#prerequisites) + - [Installation](#installation) + - [Running the Project](#running-the-project) + - [License](#license) + +## Getting Started + +### Prerequisites + +Make sure you have [Bun](https://bun.sh/) installed. + +You can install it by following the guide [here](https://bun.sh/docs/installation) + +## Installation + +Install dependencies: + +```sh +bun install +``` + +## Running the Project + +To start the development server, run: + +```sh +bun run dev +``` + +To build the project for production, run: + +```sh +bun run build +``` + +To run tests, use: + +```sh +bun run test +``` + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. diff --git a/bun.lockb b/bun.lockb index 75819d3..b2ce0a5 100755 Binary files a/bun.lockb and b/bun.lockb differ