Skip to content

Commit

Permalink
chore: updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
KANAjetzt authored Jan 5, 2024
1 parent 2c262ca commit dd3da3f
Showing 1 changed file with 26 additions and 25 deletions.
51 changes: 26 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,39 @@
# create-svelte
<div align="center">

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
<a href="https://dashboard.twitch.tv/extensions/f5ldnv4ljzxua2qryqqm3blwrequz5-0.0.1">

## Creating a project
<img alt="Corrogo Logo" src="https://github.com/KANAjetzt/BrotatoTwitchExtension/assets/41547570/95f42ef3-2b2d-4020-8a9a-4ee8ec3f36ae" width="250" />

If you're seeing this, you've probably already done this step. Congrats!
</a>

```bash
# create a new project in the current directory
npm create svelte@latest
</div>

# create a new project in my-app
npm create svelte@latest my-app
```
<h1 align="center">
<a href="https://dashboard.twitch.tv/extensions/f5ldnv4ljzxua2qryqqm3blwrequz5-0.0.1">Twitch - Brotato Overlay</a>
</h1>

## Developing
<br>

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
Get all the information about items, weapons, and stats currently used in a run.

```bash
npm run dev
- Supports modded items
- Weapon and item tooltips with detailed effect information
- Sorting options for items
- Primary and secondary stats

# or start the server and open the app in a new browser tab
npm run dev -- --open
```
<br>

## Building
<div align="center">

To create a production version of your app:
<img alt="Screenshot showing 3 panels with item icons and stats" src="https://github.com/KANAjetzt/BrotatoTwitchExtension/assets/41547570/3160b314-4ef4-42cc-bf76-ce8ee6bdbc09" width="720" />

https://github.com/KANAjetzt/BrotatoTwitchExtension/assets/41547570/9c293e9b-71b0-4fa2-be44-5eced8de40b7

</div>

```bash
npm run build
```
## Build With

You can preview the production build with `npm run preview`.

> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
<ul>
<li> <a href="https://github.com/sveltejs/svelte">Svelte</a></li>
<li> <a href="https://dev.twitch.tv/docs/extensions/reference/#javascript-helper">Twitch JS Helper</a></li>
</ul>

0 comments on commit dd3da3f

Please sign in to comment.