|
| 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 | + |
1 | 7 | ## 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> |
3 | 9 |
|
4 | 10 | [**📚 Read this template tutorial! 📚**][template-docs] |
5 | 11 |
|
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. |
8 | 13 |
|
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`. |
11 | 15 |
|
12 | 16 | [tutorials]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html |
13 | 17 | [template-docs]: https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html |
14 | 18 |
|
| 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 | + |
15 | 30 | ## 🚴 Usage |
16 | 31 |
|
17 | 32 | ### 🐑 Use `cargo generate` to Clone this Template |
18 | 33 |
|
19 | 34 | [Learn more about `cargo generate` here.](https://github.com/ashleygwilliams/cargo-generate) |
20 | 35 |
|
21 | | -``` |
| 36 | +```sh |
22 | 37 | cargo generate --git https://github.com/rustwasm/wasm-pack-template.git --name my-project |
23 | 38 | cd my-project |
24 | 39 | ``` |
25 | 40 |
|
26 | 41 | ### 🛠️ Build with `wasm-pack build` |
27 | 42 |
|
28 | | -``` |
| 43 | +```sh |
29 | 44 | wasm-pack build |
30 | 45 | ``` |
31 | 46 |
|
32 | 47 | ### 🔬 Test in Headless Browsers with `wasm-pack test` |
33 | 48 |
|
34 | | -``` |
| 49 | +```sh |
35 | 50 | wasm-pack test --headless --firefox |
36 | 51 | ``` |
37 | 52 |
|
38 | 53 | ### 🎁 Publish to NPM with `wasm-pack publish` |
39 | 54 |
|
40 | | -``` |
| 55 | +```sh |
41 | 56 | wasm-pack publish |
42 | 57 | ``` |
43 | 58 |
|
44 | 59 | ## 🔋 Batteries Included |
45 | 60 |
|
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 |
51 | 66 |
|
52 | | -## License |
| 67 | + |
| 68 | + |
53 | 69 |
|
54 | | -Licensed under either of |
| 70 | +## 📝 License |
| 71 | + |
| 72 | +This project is licensed under either of |
55 | 73 |
|
56 | 74 | * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) |
57 | 75 | * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) |
58 | 76 |
|
59 | 77 | at your option. |
60 | 78 |
|
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 | +--- |
62 | 84 |
|
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