Skip to content

Commit

Permalink
version bump + development.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sayan751 committed Aug 30, 2020
1 parent fefb7d3 commit 2b42d96
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 40 deletions.
2 changes: 1 addition & 1 deletion npm-pkg/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@sparser/email-address-parser",
"description": "An RFC 5322 compliant email address parser.",
"version": "0.3.0-rc1",
"version": "0.3.0-rc2",
"license": "MIT",
"author": {
"name": "Sayan751"
Expand Down
2 changes: 1 addition & 1 deletion rust-lib/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion rust-lib/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "email-address-parser"
version = "0.3.0-rc1"
version = "0.3.0-rc2"
authors = ["Sayan751"]
edition = "2018"
description = "An RFC 5322 compliant email address parser."
Expand Down
33 changes: 33 additions & 0 deletions rust-lib/Development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
### Build
- Only Rust
```shell
cargo build
```
- WASM
```shell
wasm-pack build --out-dir ../npm-pkg/dist/bundler
wasm-pack build --target nodejs --out-dir ../npm-pkg/dist/cjs
```

### Test

- Only Rust
```shell
cargo test
```

- WASM
```shell
wasm-pack test --node
```

### Doc generation

```shell
cargo doc --no-deps --open
```

### Publishing checklist
[] Update crate version and commit.
[] Add git tag with `git tag -a v{TAG} -m "{MSG}"`.
[] Push tag `git push --follow-tags`.
38 changes: 1 addition & 37 deletions rust-lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,40 +25,4 @@ To parse an email address with obsolete parts (as per RFC 5322) in it, pass `Non
```rust
let email = EmailAddress::parse("\u{0d}\u{0a} \u{0d}\u{0a} [email protected]", None);
assert!(email.is_some());
```

## Development

### Build
- Only Rust
```shell
cargo build
```
- WASM
```shell
wasm-pack build --out-dir ../npm-pkg/dist/bundler
wasm-pack build --target nodejs --out-dir ../npm-pkg/dist/cjs
```

### Test

- Only Rust
```shell
cargo test
```

- WASM
```shell
wasm-pack test --node
```

### Doc generation

```shell
cargo doc --no-deps --open
```

### Publishing checklist
[] Update crate version and commit.
[] Add git tag with `git tag -a v{TAG} -m "{MSG}"`.
[] Push tag `git push --follow-tags`.
```

0 comments on commit 2b42d96

Please sign in to comment.