Skip to content

Commit 4f2faca

Browse files
committed
Add the standard WG header to the README
1 parent 03319db commit 4f2faca

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

README.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,49 @@
1-
# Weedle - A WebIDL Parser
1+
<div align="center">
2+
3+
<h1>Weedle</h1>
4+
5+
<strong>A Web IDL parser</strong>
6+
7+
<p>
8+
<a href="https://travis-ci.org/rustwasm/weedle"><img src="https://img.shields.io/travis/rustwasm/weedle.svg?style=flat-square" alt="Build Status" /></a>
9+
<a href="https://crates.io/crates/weedle"><img src="https://img.shields.io/crates/v/weedle.svg?style=flat-square" alt="Crates.io version" /></a>
10+
<a href="https://crates.io/crates/weedle"><img src="https://img.shields.io/crates/d/weedle.svg?style=flat-square" alt="Download" /></a>
11+
<a href="https://docs.rs/weedle"><img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square" alt="docs.rs docs" /></a>
12+
</p>
13+
14+
<h3>
15+
<a href="https://docs.rs/weedle">API Docs</a>
16+
<span> | </span>
17+
<a href="https://discordapp.com/channels/442252698964721669/443151097398296587">Chat</a>
18+
</h3>
19+
20+
<sub>Built with 🦀🕸 by <a href="https://rustwasm.github.io/">The Rust and WebAssembly Working Group</a></sub>
21+
</div>
22+
23+
## About
224

325
Parses valid WebIDL definitions & produces a data structure starting from
426
[`Definitions`](https://docs.rs/weedle/latest/weedle/type.Definitions.html).
527

6-
### Basic Usage
28+
## Usage
29+
30+
### `Cargo.toml`
731

8-
In Cargo.toml
932
```toml
1033
[dependencies]
1134
weedle = "0.9.0"
1235
```
1336

14-
Then, in `src/main.rs`
15-
```rust
16-
extern crate weedle;
37+
### `src/main.rs`
1738

39+
```rust
1840
fn main() {
1941
let parsed = weedle::parse("
2042
interface Window {
2143
readonly attribute Storage sessionStorage;
2244
};
2345
").unwrap();
46+
2447
println!("{:?}", parsed);
2548
}
2649
```

0 commit comments

Comments
 (0)