Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Karthik99999 committed Feb 20, 2024
1 parent 51bff48 commit 2aa5400
Showing 1 changed file with 17 additions and 22 deletions.
39 changes: 17 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,33 @@
# create-svelte
# pmd-gen

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).

## Creating a project

If you're seeing this, you've probably already done this step. Congrats!

```bash
# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app
```
`pmd-gen` is a compilation of password generators for the Pokémon Mystery Dungeon™ series, written in Svelte and Typescript.

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
Once you've created a project and installed dependencies with `bun install` (or `npm install`), start a development server:

```bash
npm run dev
bun run dev

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

## Building

To create a production version of your app:

```bash
npm run build
bun run build
```

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

## TODO

- Add support for older games
- Red/Blue Rescue Team
- Explorers of Time/Darkness
- Explorers of Sky

## License

> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
[MIT](https://choosealicense.com/licenses/mit/)

0 comments on commit 2aa5400

Please sign in to comment.