Skip to content

Commit 5480f34

Browse files
author
An Phan
committed
Amend doc following revamp
1 parent bd6a9fd commit 5480f34

File tree

2 files changed

+24
-13
lines changed

2 files changed

+24
-13
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Contributing Guide
22

3-
1. Make sure you put things in the right category!
4-
2. Always add your items to the end of a list. To be fair, the order is first-come-first-serve.
5-
3. If you think something belongs in the wrong category, or think there needs to be a new category, feel free to edit things too.
3+
To add another awesome resource, simply create a `.md` file under an appropriate directory in `/awesomeness` with these contents:
4+
5+
``` yaml
6+
---
7+
name: Your Project Name
8+
url: http://yourproject.io
9+
author: "Your Name (http://yourhomepage.net)"
10+
description: "[Markdown](https://daringfireball.net/projects/markdown/) is supported!"
11+
tags:
12+
- pure
13+
- awesomess
14+
```
15+
16+
The only mandatory information is `name`, though obviously, you're encouraged to fill in as much information as you can!
17+
18+
Note: Since the `.md` file actually uses YAML syntax and is parsed by a YAML parser, you'll need quotes if your content includes special characters, e.g. `:`, `{`, `}`, `[`, `]`, `,`, `&`, `*`, `#`, `?`, `|`, `-`, `<`, `>`, `=`, `!`, `%`, `@`, `\`. Or, to play it safe, just quote all the things™!

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
# awesome-vue
22

3-
> A curated list of awesome things related to Vue.js
3+
A curated list of awesome things related to Vue.js. Inspired by [HTML5 Please](https://github.com/h5bp/html5please/). See the site in action [here](https://awesome.vuejs.org).
44

55
## Build Setup
66

7-
``` bash
8-
# install dependencies
9-
npm install
7+
Here you go:
108

11-
# serve with hot reload at localhost:8080
12-
npm run dev
9+
* `npm install` to install dependencies
10+
* `npm run dev` to serve the dev version with hot reload at localhost:8080
11+
* `npm run build` to build for production with minification
12+
* `npm run parse` to parse the awesome resources into a JSON data file
1313

14-
# build for production with minification
15-
npm run build
16-
```
14+
## License
1715

18-
For detailed explanation on how things work, consult the [docs for vue-loader](http://vuejs.github.io/vue-loader).
16+
MIT

0 commit comments

Comments
 (0)