Unofficial imgix crate

Overview

The imgix-rs crate provides functionality for programmatically constructing imgix-urls. This crate is a work in progress and is not currently ready for production use.

This crate seeks to be explicit and correct. It is also currently a side-project (and unofficial). Right now, the project structure looks like this:

.
└──  src
   ├── bin
   └── imgix

Where the bin/ directory represents the cli portion of the project and the imgix/ directory represents the crate that the cli and users use. The project may be split into separate crates in the future: one for the cli and one for the crate the cli depends on.

For a more detailed description of this project's architecture read this.

Contents

• Unofficial imgix crate
  • Overview
  • Contents
  • Requirements
  • Installation
  • Contributing
  • Prerequisites
  • Clone
  • Build
  • Test
  • Read
    • Publicly
    • Locally
  • Run

Requirements

imgix-rs is written in Rust and currently only depends on clap.

Installation

Coming soon! For now, you can git clone this repository.

Contributing

Contributions are welcome! No contribution is too small––bug fix, a new feature, feature-request, or a typo fix––all are welcome.

• contribution template
• issue template

Prerequisites

imgix-rs is written in Rust so make sure you have Rust installed

Clone

Clone the repository:

$ git clone https://github.com/ericdeansanchez/imgix-rs.git

Build

cd into the repository and run:

$ cargo build

Test

Ensure the tests pass on your system (please open an issue if they do not):

$ cargo test

Read

Publicly

The published docs can be found here at docs.rs.

Locally

Copy & paste the command below in your terminal. Make sure --no-deps is passed otherwise you'll build documentation for all/any dependencies.

$ cargo doc --no-deps --open

Run

Calling run without arguments

$ cargo run

leads to the cli help message.