misc: document 3scale fork of proxy-wasm-rust-sdk

This explains why we are maintaining this fork for the time being.

Signed-off-by: Alejandro Martinez Ruiz <[email protected]>

Author: unleashed

CHANGELOG.md

@@ -1,19 +1,11 @@
 # Changelog
 
-## [0.1.2] - 2020-08-05
+## [0.1.0] - 2020-11-05
 
-- Updated MapType values to match updated Proxy-Wasm ABI v0.1.0.
+- Initial fork (based off [d159da4]) + patches of upstream proxy-wasm-rust-sdk.
+  Note that there are breaking changes so the API is not fully compatible with
+  upstream, although it's still close enough.
 
-## [0.1.1] - 2020-08-05
 
-- Added support for building with Bazel.
-- Added support for setting HTTP bodies.
-
-## [0.1.0] - 2020-02-29
-
-- Initial release.
-
-
-[0.1.2]: https://github.com/proxy-wasm/proxy-wasm-rust-sdk/releases/tag/v0.1.2
-[0.1.1]: https://github.com/proxy-wasm/proxy-wasm-rust-sdk/releases/tag/v0.1.1
-[0.1.0]: https://github.com/proxy-wasm/proxy-wasm-rust-sdk/releases/tag/v0.1.0
+[d159da4]: https://github.com/proxy-wasm/proxy-wasm-rust-sdk/tree/d159da45dd67994db6d1f879283a4a968a8f4831
+[0.1.0]: https://github.com/3scale/proxy-wasm-rust-sdk/releases/tag/v0.1.0

Cargo.toml

@@ -1,11 +1,11 @@
 [package]
-name = "proxy-wasm"
-version = "0.1.2"
-authors = ["Piotr Sikora <[email protected]>"]
-description = "WebAssembly for Proxies"
+name = "proxy-wasm-3scale"
+version = "0.1.0"
+authors = ["Piotr Sikora <[email protected]>", "Alex Martinez Ruiz <[email protected]>"]
+description = "WebAssembly for Proxies - 3scale version"
 readme = "README.md"
 license = "Apache-2.0"
-repository = "https://github.com/proxy-wasm/proxy-wasm-rust-sdk"
+repository = "https://github.com/3scale/proxy-wasm-rust-sdk"
 edition = "2018"
 
 [features]

README.md

@@ -1,19 +1,32 @@
-# WebAssembly for Proxies (Rust SDK)
-
-[![Build Status][build-badge]][build-link]
-[![Crate][crate-badge]][crate-link]
-[![Documentation][docs-badge]][docs-link]
-[![Apache 2.0 License][license-badge]][license-link]
-
-
-[build-badge]: https://github.com/proxy-wasm/proxy-wasm-rust-sdk/workflows/Rust/badge.svg?branch=master
-[build-link]: https://github.com/proxy-wasm/proxy-wasm-rust-sdk/actions?query=workflow%3ARust+branch%3Amaster
-[crate-badge]: https://img.shields.io/crates/v/proxy-wasm.svg
-[crate-link]: https://crates.io/crates/proxy-wasm
-[docs-badge]: https://docs.rs/proxy-wasm/badge.svg
-[docs-link]: https://docs.rs/proxy-wasm
-[license-badge]: https://img.shields.io/github/license/proxy-wasm/proxy-wasm-rust-sdk
-[license-link]: https://github.com/proxy-wasm/proxy-wasm-rust-sdk/blob/master/LICENSE
+# WebAssembly for Proxies (Rust SDK) - 3scale version
+
+This is a fork of the upstream [proxy-wasm-rust-sdk](https://github.com/proxy-wasm/proxy-wasm-rust-sdk) repository intended to be used as the base proxy-wasm
+library to develop extensions in Rust at Red Hat.
+
+Most patches you will find here have associated open pull requests or issues
+in the upstream project from various people.
+
+3scale intends for this fork to closely follow upstream while addressing
+shortcomings we believe to be important for WASM module development. Hopefully
+we'll keep differences with upstream to a minimum as new upstream releases
+address these issues. This means we expect some such issues to be solved in
+potentially incompatible ways, for which we'll just break compatibility and
+ship new major versions. Over time and as the proxy-wasm ABI spec and
+development stabilizes, we expect the need for this fork to fade away.
+
+If you want to use this proxy-wasm fork, make sure to pin your project to a
+specific tag or a `-stable` release. If you want to minimise diffs when you
+switch over to upstream at a later point, be sure to use package renaming in
+your cargo manifest's dependencies section:
+
+> proxy-wasm = { git = "https://github.com/3scale/proxy-wasm-rust-sdk", branch = "v0.1-stable", package = "proxy-wasm-3scale" }
+
+## Contributing
+
+While the plan is to maintain this project as a lightweight fork on top of
+upstream, we welcome PRs, but we request contributors to make sure any new
+code is also PR'ed to the upstream project unless it touches something that
+upstream won't add or is undecided or unresponsive about.
 
 ## Examples