Skip to content

Commit

Permalink
added package metadata and updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xec committed Mar 8, 2020
1 parent 221f14a commit d95bb92
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# Svelte Todo

Simple Todo svelte component based on official svelte tutorial
Simple Todo svelte component based on [official svelte tutorial](https://svelte.dev/tutorial/animate)

* under development, not ready for production use
* stores state in localStorage for now

## Get started

Install from github until a version is published to npm repository
Install with npm

```bash
npm i -D xec/svelte-todo
npm i -D @xec/svelte-todo
```

Import in your `.svelte` file
```html
<script>
import Todo from '@xec/svelte-todo'
Expand Down
19 changes: 17 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,32 @@
"dev": "rollup -c -w",
"start": "sirv public"
},
"repository": {
"type": "git",
"url": "https://github.com/xec/svelte-todo.git"
},
"keywords": [
"xec",
"svelte",
"todo"
],
"homepage": "https://xec.github.io/todo/",
"author": "Eric Morton",
"license": "GPL-3.0-or-later",
"bugs": {
"url": "https://github.com/xec/svelte-todo/issues"
},
"devDependencies": {
"@rollup/plugin-commonjs": "^11.0.0",
"@rollup/plugin-node-resolve": "^7.0.0",
"rollup": "^1.20.0",
"rollup-plugin-livereload": "^1.0.0",
"rollup-plugin-svelte": "^5.0.3",
"rollup-plugin-terser": "^5.1.2"
"rollup-plugin-terser": "^5.1.2",
"sirv-cli": "^0.4.4"
},
"dependencies": {
"@fortawesome/free-solid-svg-icons": "^5.12.1",
"sirv-cli": "^0.4.4",
"svelte": "^3.0.0",
"svelte-awesome": "^2.2.1"
}
Expand Down

0 comments on commit d95bb92

Please sign in to comment.