Skip to content

Commit a9a2ba6

Browse files
committed
update readme.md
1 parent 942f433 commit a9a2ba6

File tree

1 file changed

+40
-21
lines changed

1 file changed

+40
-21
lines changed

README.md

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,85 @@
1+
Here's a `README.md` for your Rust-WASM Todo List project. It includes sections for easy navigation, relevant emojis, and placeholders for images:
2+
3+
---
4+
5+
# 🦀🕸 Rust-WASM Todo List
6+
17
## About
2-
<sub>Built with 🦀🕸 by <a href="https://rustwasm.github.io/">The Rust and WebAssembly Working Group</a></sub>
8+
<sub>Built with 🦀🕸 by [The Rust and WebAssembly Working Group](https://rustwasm.github.io/)</sub>
39

410
[**📚 Read this template tutorial! 📚**][template-docs]
511

6-
This template is designed for compiling Rust libraries into WebAssembly and
7-
publishing the resulting package to NPM.
12+
This project is a simple Todo List application built using Rust and WebAssembly (WASM). It's one of the more unusual projects I've ever worked on, showcasing the power of Rust and WASM in a web application.
813

9-
Be sure to check out [other `wasm-pack` tutorials online][tutorials] for other
10-
templates and usages of `wasm-pack`.
14+
Be sure to check out [other `wasm-pack` tutorials online][tutorials] for other templates and usages of `wasm-pack`.
1115

1216
[tutorials]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html
1317
[template-docs]: https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html
1418

19+
## 📋 Table of Contents
20+
- [🚴 Usage](#-usage)
21+
- [🐑 Clone this Template](#-use-cargo-generate-to-clone-this-template)
22+
- [🛠️ Build with `wasm-pack build`](#️-build-with-wasm-pack-build)
23+
- [🔬 Test in Headless Browsers](#-test-in-headless-browsers-with-wasm-pack-test)
24+
- [🎁 Publish to NPM](#-publish-to-npm-with-wasm-pack-publish)
25+
- [🔋 Batteries Included](#-batteries-included)
26+
- [🖼️ Screenshots](#-screenshots)
27+
- [📝 License](#-license)
28+
- [🤝 Contribution](#-contribution)
29+
1530
## 🚴 Usage
1631

1732
### 🐑 Use `cargo generate` to Clone this Template
1833

1934
[Learn more about `cargo generate` here.](https://github.com/ashleygwilliams/cargo-generate)
2035

21-
```
36+
```sh
2237
cargo generate --git https://github.com/rustwasm/wasm-pack-template.git --name my-project
2338
cd my-project
2439
```
2540

2641
### 🛠️ Build with `wasm-pack build`
2742

28-
```
43+
```sh
2944
wasm-pack build
3045
```
3146

3247
### 🔬 Test in Headless Browsers with `wasm-pack test`
3348

34-
```
49+
```sh
3550
wasm-pack test --headless --firefox
3651
```
3752

3853
### 🎁 Publish to NPM with `wasm-pack publish`
3954

40-
```
55+
```sh
4156
wasm-pack publish
4257
```
4358

4459
## 🔋 Batteries Included
4560

46-
* [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating
47-
between WebAssembly and JavaScript.
48-
* [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook)
49-
for logging panic messages to the developer console.
50-
* `LICENSE-APACHE` and `LICENSE-MIT`: most Rust projects are licensed this way, so these are included for you
61+
* [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating between WebAssembly and JavaScript.
62+
* [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook) for logging panic messages to the developer console.
63+
* `LICENSE-APACHE` and `LICENSE-MIT`: most Rust projects are licensed this way, so these are included for you.
64+
65+
## 🖼️ Screenshots
5166

52-
## License
67+
![Screenshot 1](path/to/screenshot1.png)
68+
![Screenshot 2](path/to/screenshot2.png)
5369

54-
Licensed under either of
70+
## 📝 License
71+
72+
This project is licensed under either of
5573

5674
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
5775
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
5876

5977
at your option.
6078

61-
### Contribution
79+
## 🤝 Contribution
80+
81+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
82+
83+
---
6284

63-
Unless you explicitly state otherwise, any contribution intentionally
64-
submitted for inclusion in the work by you, as defined in the Apache-2.0
65-
license, shall be dual licensed as above, without any additional terms or
66-
conditions.
85+
This README provides a clear structure, helpful emojis, and all necessary information about the project, including sections for usage, building, testing, publishing, and contribution guidelines. It also includes placeholders for screenshots to visually represent your project.

0 commit comments

Comments
 (0)