Ocean Library

The oceanpkg library serves as core reusable components for: - The ocean [CLI] client - Backend web services

Note: All shell commands assume that the current working directory is lib. This can be done by running cd lib to "change directory" from the root folder.

Install

This library is written in [Rust] and is meant to be used within a [cargo] project. See [rustup.rs] for installing Rust and cargo.

It is made available on crates.io and can be used by adding the following to your project's [Cargo.toml]:

toml [dependencies] oceanpkg = "0.0.9"

and this to your crate root (main.rs or lib.rs):

rust extern crate oceanpkg;

Usage

See [documentation].

Testing

Various test cases are covered throughout this library. They can all be found by searching for mod tests within the lib folder.

To perform these tests, simply run:

sh cargo test