2017-07-13 08:08:14 +00:00
|
|
|
# rocket_cors
|
|
|
|
|
|
|
|
[![Build Status](https://travis-ci.org/lawliet89/rocket_cors.svg)](https://travis-ci.org/lawliet89/rocket_cors)
|
|
|
|
[![Repository](https://img.shields.io/github/tag/lawliet89/rocket_cors.svg)](https://github.com/lawliet89/rocket_cors)
|
2017-07-18 10:22:20 +00:00
|
|
|
[![Crates.io](https://img.shields.io/crates/v/rocket_cors.svg)](https://crates.io/crates/rocket_cors)
|
2017-07-13 08:08:14 +00:00
|
|
|
|
2018-10-31 02:58:23 +00:00
|
|
|
- Documentation: [master branch](https://lawliet89.github.io/rocket_cors) | [stable](https://docs.rs/rocket_cors)
|
2017-07-13 08:08:14 +00:00
|
|
|
|
|
|
|
Cross-origin resource sharing (CORS) for [Rocket](https://rocket.rs/) applications
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
|
|
- Nightly Rust
|
2018-11-01 01:21:50 +00:00
|
|
|
- Rocket >= 0.4
|
|
|
|
|
|
|
|
If you are using Rocket 0.3, use the `0.3.0` version of this crate.
|
2017-07-13 08:08:14 +00:00
|
|
|
|
|
|
|
### Nightly Rust
|
|
|
|
|
2017-07-15 02:37:10 +00:00
|
|
|
Rocket requires nightly Rust. You should probably install Rust with
|
|
|
|
[rustup](https://www.rustup.rs/), then override the code directory to use nightly instead of stable.
|
|
|
|
See
|
2017-07-13 08:08:14 +00:00
|
|
|
[installation instructions](https://rocket.rs/guide/getting-started/#installing-rust).
|
|
|
|
|
2018-02-14 05:20:31 +00:00
|
|
|
In particular, `rocket_cors` is currently targetted for the latest `nightly`. Older nightlies might
|
|
|
|
work, but they are subject to the minimum that Rocket sets.
|
2017-07-13 08:08:14 +00:00
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
2017-07-18 10:22:20 +00:00
|
|
|
Add the following to Cargo.toml:
|
2017-07-13 08:08:14 +00:00
|
|
|
|
|
|
|
```toml
|
2019-03-12 05:09:15 +00:00
|
|
|
rocket_cors = "0.5.0"
|
2017-07-18 10:22:20 +00:00
|
|
|
```
|
2017-07-13 08:08:14 +00:00
|
|
|
|
|
|
|
To use the latest `master` branch, for example:
|
|
|
|
|
|
|
|
```toml
|
2017-07-14 03:03:45 +00:00
|
|
|
rocket_cors = { git = "https://github.com/lawliet89/rocket_cors", branch = "master" }
|
2017-07-13 08:08:14 +00:00
|
|
|
```
|
2017-07-14 03:03:45 +00:00
|
|
|
|
|
|
|
## Reference
|
|
|
|
|
|
|
|
- [W3C CORS Recommendation](https://www.w3.org/TR/cors/#resource-processing-model)
|
2018-07-18 05:29:02 +00:00
|
|
|
|
|
|
|
## License
|
|
|
|
|
2018-07-18 05:30:54 +00:00
|
|
|
`rocket_cors` is licensed under either of the following, at your option:
|
2018-07-18 05:29:02 +00:00
|
|
|
|
|
|
|
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
|
|
|
- MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|