Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
loiccoyle authored Oct 20, 2024
1 parent 14d7aeb commit 8756e2b
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@
<img src="https://img.shields.io/badge/platform-linux%20%7c%20macos%20%7c%20windows-informational">
</p>

<p align="center">
<b>
Make your own photo mosaics <a href="https://loiccoyle.com/phomo-rs">here</a>
</b>
</p>


This repo contains two crates:

- `phomo` crate contains the photo mosaic generation library.
Expand All @@ -20,3 +27,48 @@ This repo contains two crates:
And one `npm` package:

- `phomo-wasm` provides the `wasm` bindings and allows `phomo` to be used in the browser.

## 📦 Installation

## Command line

To use the `phomo` binary to build photo mosaics, install the `phomo-cli` crate:

```sh
cargo install phomo-cli
```

### Usage

Once installed, you can use the `phomo` binary.

Something like:

```sh
phomo master_image.png tile_directory/ output_mosaic.png
```

If doubt see the help:

<!-- help start -->
<!-- help end -->

## Library

To use the library as a dependency in your projects, add the `phomo` crate:

```sh
cargo add phomo
```

See the [docs](https://docs.rs/phomo) for usage.

## Wasm

To use the `wasm` bindings in your project, add the `phomo-wasm` `npm` package:

```sh
npm add phomo-wasm
```

I would recommend taking a look at the [demo page's source code](https://github.com/loiccoyle/phomo-rs/tree/gh-pages).

0 comments on commit 8756e2b

Please sign in to comment.