Skip to content

Commit

Permalink
Add readmes and link license files.:
Browse files Browse the repository at this point in the history
Signed-off-by: Aalekh Patel <[email protected]>
  • Loading branch information
aalekhpatel07 committed Jun 14, 2022
1 parent e1a78fe commit 8d435ad
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 2 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Text Cleaner

Perform "cleaning" operations on text like removing emails, urls, or punctuation marks, etc with the help of a WASM-based web app.

## Frontend (Yew + Rust)
[here](./yew-frontend/README.md)

## Core Text Processing Library (Rust)
[Here](./text-cleaner/README.md)

## Native app packager (Tauri + Rust)
[here](./src-tauri/README.md)
5 changes: 3 additions & 2 deletions src-tauri/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
[package]
name = "text-cleaner-app"
version = "0.1.0"
version = "1.0.0"
description = "A Tauri app to clean some text with common operations."
authors = ["Aalekh Patel <[email protected]>"]
license = ""
license-file = "../LICENSE.md"
repository = "http:https://github.com/aalekhpatel07/text-cleaner"
default-run = "text-cleaner-app"
edition = "2021"
rust-version = "1.57"
readme = "README.md"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Expand Down
18 changes: 18 additions & 0 deletions src-tauri/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Text Cleaner Native App Packaging Tool

Understanding [Tauri](https://tauri.studio/v1/api/cli/).

## Usage

### Development

```sh
cargo tauri dev
```

### Build

```sh
cargo tauri build --verbose
```

1 change: 1 addition & 0 deletions text-cleaner/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ version = "0.1.0"
edition = "2021"
description = "An implementation of some common text manipulation operations."
license-file = "../LICENSE.md"
readme = "README.md"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Expand Down
12 changes: 12 additions & 0 deletions text-cleaner/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Text Cleaner

This is a Rust library that provides the `Clean` trait and some implementations.

## Usage

Add to your Rust project.

```sh
cargo add text-cleaner
```

0 comments on commit 8d435ad

Please sign in to comment.