Skip to content

Open-source status page, incident response and uptime monitoring

improve readme (#4)

Thibault Le Ouay3e0d8cc4e8c1
diff --git a/README.md b/README.md
index bc389a063..a7ec8e918 100644
--- a/README.md
+++ b/README.md
@@ -1,81 +1,46 @@
-# Turborepo starter
+# OpenStatus
-This is an official starter Turborepo.
+The Open-source monitoring platform
-## Using this example
+## Built with
-Run the following command:
+- [Next.js](https://nextjs.org/)
+- [Tailwind CSS](https://tailwindcss.com/)
+- [shadcn/ui](https://ui.shadcn.com/)
-```sh
-npx create-turbo@latest
-```
-## What's inside?
-This Turborepo includes the following packages/apps:
+## Getting Started
-### Apps and Packages
+### Requirements
-- `docs`: a [Next.js](https://nextjs.org/) app
-- `web`: another [Next.js](https://nextjs.org/) app
-- `ui`: a stub React component library shared by both `web` and `docs` applications
-- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
-- `tsconfig`: `tsconfig.json`s used throughout the monorepo
+- [Node.js](https://nodejs.org/en/) >= 18.0.0
+- [pnpm](https://pnpm.io/) >= 8.6.2
-Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
+### Setup
-### Utilities
+1. Clone the repository
-This Turborepo has some additional tools already setup for you:
+ ```sh
+ git clone https://github.com/openstatusHQ/openstatus.git
+ ```
-- [TypeScript](https://www.typescriptlang.org/) for static type checking
-- [ESLint](https://eslint.org/) for code linting
-- [Prettier](https://prettier.io) for code formatting
+2. Install dependencies
-### Build
+ ```sh
+ pnpm install
+ ```
-To build all apps and packages, run the following command:
+3. Start the development server
-```
-cd my-turborepo
-pnpm build
-```
+ ```sh
+ pnpm dev
+ ```
-### Develop
+4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-To develop all apps and packages, run the following command:
-```
-cd my-turborepo
-pnpm dev
-```
+## Authors
-### Remote Caching
-
-Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
-
-By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:
-
-```
-cd my-turborepo
-npx turbo login
-```
-
-This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
-
-Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
-
-```
-npx turbo link
-```
-
-## Useful Links
-
-Learn more about the power of Turborepo:
-
-- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
-- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
-- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
-- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
-- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
-- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
+- [Maximilian Kaske](https://twitter.com/mxkaske)
+- [Thibault Le Ouay Ducasse](https://twitter.com/thibaultleouay)
\ No newline at end of file