Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ken-matsui committed Sep 2, 2024
1 parent 0cb756f commit 73a481e
Showing 1 changed file with 1 addition and 74 deletions.
75 changes: 1 addition & 74 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# jyt [![crates.io version](https://img.shields.io/crates/v/jyt.svg)](https://crates.io/crates/jyt) [![crates.io downloads](https://img.shields.io/crates/d/jyt.svg)](https://crates.io/crates/jyt)

A tridirectional converter between **J**son, **Y**aml, and **T**oml which supports both native and WebAssembly
A tridirectional converter between **J**son, **Y**aml, and **T**oml

## Installation

Expand All @@ -10,15 +10,6 @@ You can install this using the `cargo install` command:
$ cargo install jyt
```

### WebAssembly

This application also provides a wasm package.
You can install it using [`wapm`](https://wapm.io/help/install) by the following command:

```bash
$ wapm install ken-matsui/jyt
```

## Usage

```mermaid
Expand Down Expand Up @@ -54,30 +45,6 @@ SUBCOMMANDS:
yaml-to-toml Convert Yaml to Toml (also as `yaml2toml`, `y2t`, and `yt`)
```

### WebAssembly

```bash
$ wapm run jyt -- --help
jyt 0.1.0
A tridirectional converter between Json, Yaml, and Toml

USAGE:
jyt <SUBCOMMAND>

OPTIONS:
-h, --help Print help information
-V, --version Print version information

SUBCOMMANDS:
help Print this message or the help of the given subcommand(s)
json-to-toml Convert Json to Toml (also as `json2toml`, `j2t`, and `jt`)
json-to-yaml Convert Json to Yaml (also as `json2yaml`, `j2y`, and `jy`)
toml-to-json Convert Toml to Json (also as `toml2json`, `t2j`, and `tj`)
toml-to-yaml Convert Toml to Yaml (also as `toml2yaml`, `t2y`, and `ty`)
yaml-to-json Convert Yaml to Json (also as `yaml2json`, `y2j`, and `yj`)
yaml-to-toml Convert Yaml to Toml (also as `yaml2toml`, `y2t`, and `yt`)
```

## Examples

### JSON -> YAML
Expand Down Expand Up @@ -199,27 +166,6 @@ $ echo $?
0
```

### WebAssembly

### TOML -> YAML

```bash
$ cat ./examples/example.toml | wapm run jyt -- toml2yaml
title: TOML Example
owner:
name: Tom Preston-Werner
database:
server: 192.168.1.1
ports:
- 8000
- 8001
- 8002
connection_max: 5000
enabled: true
```

... other examples are the same as native provides!

## Contribution

### Build
Expand All @@ -234,20 +180,9 @@ Or you can directly execute the binary:
$ cargo run
```

#### WebAssembly

```bash
$ rustup target add wasm32-wasi
$ cargo build --target wasm32-wasi
$ wasmer run target/wasm32-wasi/debug/jyt.wasm
```

### Test

This command can also test C API.

```bash
$ cargo build
$ cargo test
```

Expand All @@ -265,11 +200,3 @@ $ git push origin v0.1.0
```bash
$ cargo publish
```

#### [wapm.io](https://wapm.io/)

```bash
$ rustup target add wasm32-wasi
$ cargo build --release --target wasm32-wasi
$ wapm publish
```

0 comments on commit 73a481e

Please sign in to comment.