Skip to content
This repository has been archived by the owner on Jun 2, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nickwasused authored Apr 22, 2024
1 parent a5c1ab0 commit a27ddde
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,11 @@ A searchable, auto-updating list of streamers for a certain topic.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.

### Prerequisites
What things you need to install the software and how to install them.

`pnpm` [is required](https://pnpm.io/)
`twitch-search-server` [instance is required](https://github.com/Nickwasused/twitch-search-server)
`pnpm` [is required](https://pnpm.io/)
`twitch-search-server` [instance is required](https://github.com/Nickwasused/twitch-search-server)

### Installing
A step by step series of examples that tell you how to get a development env running.

Install the dependencies with:

Expand All @@ -48,7 +46,7 @@ Then you can open your browser and see the page at [http://127.0.0.1:3000/](http
No extra notes.

## 🚀 Deployment <a name = "deployment"></a>
You can see a deployment example at [./.github/workflows/build-and-deploy.yml]
You can see a deployment example at [./.github/workflows/build-and-deploy.yml](./.github/workflows/build-and-deploy.yml)

## Style
The code is formatted and checked with [prettier](https://prettier.io/)s default settings.
Expand Down

0 comments on commit a27ddde

Please sign in to comment.