Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
ziteh committed May 1, 2024
1 parent 93d3039 commit b05442a
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 31 deletions.
82 changes: 53 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
# Elebox

![](https://i.imgur.com/fqdDK1d.png)

Lightweight personal electronic parts inventory management tool.

The goal is to keep it simple and intuitive, zero configuration and works out of the box. Single-file database easy to backup.

## Usage

### Tauri GUI
Download executable from [Releases](./releases). (🚧WIP)

Install Node.js >= `20.9.0` for Vite.
### GUI

```
cd elebox
GUI powered by [Tauri](https://tauri.app/).

For development, install Node.js >= `20.9.0` for Vite.

```bash
cd elebox-tauri
pnpm install
pnpm tauri dev
```
Expand All @@ -21,69 +29,85 @@ If you're run via Cargo (i.e. not using the released executable), replace `elebo
#### Basic

Print help message:
```

```bash
elebox-cli help
```

Use and operate on the default database filename `elebox.db`:
```
Use and operate on the default database path `./elebox.db`:

```bash
elebox-cli <COMMAND>
```
or a specified filename `mybox.db`:
```

or a specified path `./mybox.db`:

```bash
elebox-cli mybox.db <COMMAND>
```

where `<COMMAND>` can be `init`, `part` or `type`.
where `<COMMAND>` can be `init`, `part` or `category`.

#### Init

Create and initialize a new database with the default filename `elebox.db`:
```
You need to initialize a database before you can proceed with the next steps.

Create and initialize a new database with the default path `./elebox.db`:

```bash
elebox-cli init
```

#### Edit Part Type
#### Edit Part category

List part types:
```
elebox-cli type
```
List part categorys:

Create a new part type named `SMD`:
```
elebox-cli type new SMD
```bash
elebox-cli category
```

Create new part type named `SOT-23` and `SMD 0603`, and designate them as a subtype of `SMD`:
Create a new part category named `SMD`:

```bash
elebox-cli category new SMD
```
elebox-cli type new SOT-23 -p SMD
elebox-cli type new "SMD 0603" -p SMD

Create new part category named `SOT-23` and `SMD 0603`, and designate them as a subcategory of `SMD`:

```bash
elebox-cli category new SOT-23 -p SMD
elebox-cli category new "SMD 0603" -p SMD
```

#### Edit Part

List parts:
```

```bash
elebox-cli part
```

Create a new part named `AMS1117` with a part type of `SMD`, and a quantity of `100`:
```
Create a new part named `AMS1117` with a part category of `SMD`, and a quantity of `100`:

```bash
elebox-cli part new AMS1117 100 SMD
```

Consume or restock 10 `AMS1117`:
```

```bash
elebox-cli part use AMS1117 10
elebox-cli part add AMS1117 10
```

Rename `AMS1117` to `ams1117-3.3v`:
```

```bash
elebox-cli part update AMS1117 ams1117-3.3v
```

## License

Licensed under either of [Apache-2.0](/LICENSE-APACHE) or [MIT license](/LICENSE-MIT) at your option.
Licensed under either of [Apache-2.0](/LICENSE-APACHE) or [MIT license](/LICENSE-MIT) at your option.

Icons from [Material Design Icons](https://pictogrammers.com/library/mdi/)
3 changes: 1 addition & 2 deletions elebox-tauri/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/

## Usage

```
cd elebox
```bash
pnpm install
pnpm tauri dev
```

0 comments on commit b05442a

Please sign in to comment.