Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ArivAfonso authored Nov 7, 2024
1 parent 4c4f57e commit e5b48ef
Showing 1 changed file with 1 addition and 30 deletions.
31 changes: 1 addition & 30 deletions apps/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1 @@
# My TypeScript Project

This is a TypeScript project that demonstrates the usage of Prettier for code formatting.

## Getting Started

To get started with this project, follow the steps below:

1. Clone the repository.
2. Install the dependencies by running `pnpm install`.
3. Build the project by running `npm run build`.
4. Start the application by running `npm start`.

## Project Structure

The project has the following files:

- `src/index.ts`: This file is the entry point of the TypeScript project. It can contain the main logic of your application.
- `.prettierrc`: This file is the configuration file for Prettier. It specifies the formatting rules for your code.
- `tsconfig.json`: This file is the configuration file for TypeScript. It specifies the compiler options and the files to include in the compilation.
- `package.json`: This file is the configuration file for npm. It lists the dependencies and scripts for the project.
- `README.md`: This file contains the documentation for the project.

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more information.

```
```
# Work in Progress 🚧

0 comments on commit e5b48ef

Please sign in to comment.