Skip to content

Commit

Permalink
docs: write README
Browse files Browse the repository at this point in the history
BREAKING CHANGE: First official release
  • Loading branch information
raulfdm committed Oct 22, 2019
1 parent 7d99e0c commit a6026eb
Showing 1 changed file with 39 additions and 5 deletions.
44 changes: 39 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,52 @@
# generate-svelte-app
# Generate Svelte App

Quick waiy to start your svelte app
> Quick way to start your Svelte app
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/generate-svelte-app.svg)](https://npmjs.org/package/generate-svelte-app)
[![Downloads/week](https://img.shields.io/npm/dw/generate-svelte-app.svg)](https://npmjs.org/package/generate-svelte-app)
[![License](https://img.shields.io/npm/l/generate-svelte-app.svg)](https://github.com/raulfdm/generate-svelte-app/blob/master/package.json)

<!-- toc -->
# Why

The only reason this CLI exists is the fact Svelte still does not have some easy way to get started with a project like `create-react-app`, `vue-cli` or `angular-cli`.

Officially they have [this tutorial](https://svelte.dev/blog/the-easiest-way-to-get-started), which suggests using `degit` to fetch a svelte template but IMO it's still a lot of work to do.

Another thing is in this specific template their are using `sirv-cli` which for some reason has some weird bug when you start the project.

In a nutshell, this CLI is using their template with some small changes in the server to proper run locally and also starts your project running one command.

# Usage

<!-- usage -->
First you have to install the CLI globally:

```bash
yarn global add generate-svelte-app
# Or if you're using Npm
# npm install generate-svelte-app --global
```

Then, you can call the CLI passing your project name:

```bash
generate-svelte-app -n my-awesome-project
```

It'll automatically create your project with the basic svelte files. All you need to do is start your app:

```bash
cd my-awesome-project
yarn start
```

# Commands

<!-- commands -->
| Command | Alias | Description | Default |
| ------- | ----- | ----------------- | ------- |
| --name | -n | Your project name | |
| --npm | | Set to use npm | yarn |

# License

[MIT](./LICENSE.md)

0 comments on commit a6026eb

Please sign in to comment.