# Product OS : Router

Product OS : Router provides a fully featured router leveraging Axum and Tower with a suite of helper methods to make it easier to create an HTTP server, HTTPS server, web socket server and even server-sent events server.

### What is Product OS?

Product OS is a collection of packages that provide different tools and features that can work together to build products more easily for the Rust ecosystem.

## Installation

Use the Rust crate package manager [cargo](https://www.rust-lang.org/tools/install) to install Product OS : Router.

```bash
cargo add product-os-router
```

or add Product OS : Router to your cargo.toml ```[packages]``` section.

```rust
product-os-router = { version = "0.0.25", features = [], default-features = true, optional = false }
```

## Features

Product OS Router supports a number of features leveraging the existing Rust libraries of Axum and Tower including:

- Set of endpoint route and fallback helper methods
- Explicit cors endpoint helper method
- WebSocket (ws) helper method
- Server-side Events (sse) helper method
- Add multiple handlers in one go
- Add middleware with a bit more ease
- Define default headers
- Create services (collections of handlers) more easily

```rust
// Feature samples TODO
```

## Usage

```rust
// Examples TODO
```

## Contributing

Contributions are not currently available but will be available on a public repository soon.

## License

[GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0/)