Skip to content

chore: added wiki to readme #442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alejandro-vaz wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

chore: added wiki to readme #442

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
rust-smallvec
=============

> **⚠️ Note:**
> This is the code for smallvec 2.0, which is not yet ready for release. For
> details about the changes in version 2.0, please see [#183], [#240], and [#284].
> The status of the v2 branch is tracked on [#425].
> [!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:
> - [its tracking issue](https://github.com/servo/rust-smallvec/issues/425)
> - [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]. Bug fixes for smallvec 1 should be based on that branch, while
> [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.

[v1 branch]: https://github.com/servo/rust-smallvec/tree/v1
[#183]: https://github.com/servo/rust-smallvec/issues/183
[#240]: https://github.com/servo/rust-smallvec/issues/240
[#284]: https://github.com/servo/rust-smallvec/issues/284
[#425]: https://github.com/servo/rust-smallvec/issues/425

## About smallvec

[Documentation](https://docs.rs/smallvec/)

[Wiki](https://github.com/servo/rust-smallvec/wiki)

[Release notes](https://github.com/servo/rust-smallvec/releases)

"Small vector" optimization for Rust: store up to a small number of items on the stack
Expand Down
Loading