diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..3d5c5a5 --- /dev/null +++ b/.github/README.md @@ -0,0 +1,15 @@ +# Contributing to rust-smallvec + +This branch contains the code for SmallVec v2, which is not yet ready for release. +If your code is using any of the alpha versions of SmallVec, be aware that the API +might change between versions. + +The status of v2 can be tracked in: + +- [the milestones](https://github.com/servo/rust-smallvec/milestones) +- [the wiki spec](https://github.com/servo/rust-smallvec/wiki) + +The source code for the latest smallvec 1.x.y release can be found on the +[v1 branch](https://github.com/servo/rust-smallvec/tree/v1). Bug fixes for +smallvec v1 should be based on that branch, while new feature development should +go on the v2 branch. diff --git a/README.md b/README.md index 50ab222..95c9578 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,6 @@ rust-smallvec ============= -> [!IMPORTANT] -> This branch contains the code for SmallVec v2, which is not yet ready for release. -> If your code is using any of the alpha version of SmallVec, beware that the API might -> change between versions. -> -> The status of v2 can be tracked in: -> - [the milestones](https://github.com/servo/rust-smallvec/milestones) -> - [the wiki spec](https://github.com/servo/rust-smallvec/wiki) -> -> The source code for the latest smallvec 1.x.y release can be found on the -> [v1 branch](https://github.com/servo/rust-smallvec/tree/v1). -> Bug fixes for smallvec v1 should be based on that branch, while -> new feature development should go on the v2 branch. - ## About smallvec [Documentation](https://docs.rs/smallvec/)