|
1 | | -<div align="center"> |
| 1 | +# Braillify |
2 | 2 |
|
3 | | - <h1><code>wasm-pack-template</code></h1> |
| 3 | +Rust 기반 크로스플랫폼 한국어 점역 라이브러리 |
4 | 4 |
|
5 | | - <strong>A template for kick starting a Rust and WebAssembly project using <a href="https://github.com/rustwasm/wasm-pack">wasm-pack</a>.</strong> |
| 5 | +<img src='https://img.shields.io/npm/v/braillify'> |
| 6 | +<img src='https://img.shields.io/bundlephobia/minzip/braillify'> |
| 7 | +<img alt="Github Checks" src="https://badgen.net/github/checks/dev-five-git/braillify"/> |
| 8 | +<img alt="Apache-2.0 License" src="https://img.shields.io/github/license/dev-five-git/braillify"/> |
| 9 | +<a href="https://www.npmjs.com/package/braillify"> |
| 10 | +<img alt="NPM Downloads" src="https://img.shields.io/npm/dm/braillify.svg?style=flat"/> |
| 11 | +</a> |
| 12 | +<a href="https://badgen.net/github/stars/dev-five-git/braillify"> |
| 13 | +<img alt="Github Stars" src="https://badgen.net/github/stars/dev-five-git/braillify" /> |
| 14 | +</a> |
| 15 | +<a href="https://discord.gg/8zjcGc7cWh"> |
| 16 | +<img alt="Discord" src="https://img.shields.io/discord/1321362173619994644.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2" /> |
| 17 | +</a> |
| 18 | +<a href="https://codecov.io/gh/dev-five-git/braillify" > |
| 19 | + <img src="https://codecov.io/gh/dev-five-git/braillify/graph/badge.svg?token=8I5GMB2X5B"/> |
| 20 | +</a> |
6 | 21 |
|
7 | | - <p> |
8 | | - <a href="https://travis-ci.org/rustwasm/wasm-pack-template"><img src="https://img.shields.io/travis/rustwasm/wasm-pack-template.svg?style=flat-square" alt="Build Status" /></a> |
9 | | - </p> |
10 | 22 |
|
11 | | - <h3> |
12 | | - <a href="https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html">Tutorial</a> |
13 | | - <span> | </span> |
14 | | - <a href="https://discordapp.com/channels/442252698964721669/443151097398296587">Chat</a> |
15 | | - </h3> |
| 23 | +## 설치 |
16 | 24 |
|
17 | | - <sub>Built with 🦀🕸 by <a href="https://rustwasm.github.io/">The Rust and WebAssembly Working Group</a></sub> |
18 | | -</div> |
19 | | - |
20 | | -## About |
21 | | - |
22 | | -[**📚 Read this template tutorial! 📚**][template-docs] |
23 | | - |
24 | | -This template is designed for compiling Rust libraries into WebAssembly and |
25 | | -publishing the resulting package to NPM. |
26 | | - |
27 | | -Be sure to check out [other `wasm-pack` tutorials online][tutorials] for other |
28 | | -templates and usages of `wasm-pack`. |
29 | | - |
30 | | -[tutorials]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html |
31 | | -[template-docs]: https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html |
32 | | - |
33 | | -## 🚴 Usage |
34 | | - |
35 | | -### 🐑 Use `cargo generate` to Clone this Template |
36 | | - |
37 | | -[Learn more about `cargo generate` here.](https://github.com/ashleygwilliams/cargo-generate) |
38 | | - |
39 | | -``` |
40 | | -cargo generate --git https://github.com/rustwasm/wasm-pack-template.git --name my-project |
41 | | -cd my-project |
| 25 | +```bash |
| 26 | +npm install braillify # node |
42 | 27 | ``` |
43 | 28 |
|
44 | | -### 🛠️ Build with `wasm-pack build` |
45 | | - |
46 | | -``` |
47 | | -wasm-pack build |
48 | | -``` |
49 | | - |
50 | | -### 🔬 Test in Headless Browsers with `wasm-pack test` |
51 | | - |
52 | | -``` |
53 | | -wasm-pack test --headless --firefox |
54 | | -``` |
55 | | - |
56 | | -### 🎁 Publish to NPM with `wasm-pack publish` |
57 | | - |
58 | | -``` |
59 | | -wasm-pack publish |
60 | | -``` |
61 | | - |
62 | | -## 🔋 Batteries Included |
63 | | - |
64 | | -* [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating |
65 | | - between WebAssembly and JavaScript. |
66 | | -* [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook) |
67 | | - for logging panic messages to the developer console. |
68 | | -* `LICENSE-APACHE` and `LICENSE-MIT`: most Rust projects are licensed this way, so these are included for you |
69 | | - |
70 | | -## License |
71 | | - |
72 | | -Licensed under either of |
73 | | - |
74 | | -* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) |
75 | | -* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) |
76 | | - |
77 | | -at your option. |
78 | | - |
79 | | -### Contribution |
80 | | - |
81 | | -Unless you explicitly state otherwise, any contribution intentionally |
82 | | -submitted for inclusion in the work by you, as defined in the Apache-2.0 |
83 | | -license, shall be dual licensed as above, without any additional terms or |
84 | | -conditions. |
| 29 | +```bash |
| 30 | +pip install braillify # python |
| 31 | +``` |
0 commit comments