Skip to content
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.

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

Keep Rust README minimal #390

Merged
merged 2 commits into from
Feb 22, 2019
Merged

Keep Rust README minimal #390

merged 2 commits into from
Feb 22, 2019

Conversation

ilammy
Copy link
Collaborator

@ilammy ilammy commented Feb 22, 2019

We have three to four places with assorted documentation on Themis and this is getting a bit hard to maintain consistency between them. Let's keep Rust README minimal so that it does not require frequent changes. Just refer to relevant pieces of documentation from it and avoid any detailed explanations.

We have three to four places with assorted documentation on Themis and
this is getting a bit hard to maintain consistency between them. Let's
keep Rust README minimal so that it does not require frequent changes.
Just refer to relevant pieces of documentation from it and avoid any
detailed explanations.
@ilammy ilammy added docs 📚 Documentation, both offline and online W-RustThemis 🦀 Wrapper: Rust-Themis, Rust API, Cargo crates labels Feb 22, 2019
Copy link
Contributor

@karenswry karenswry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please substitute for the following.
Or grant me more permissions on the branch the next time 👿 I'll edit it without bothering you.

Quickstart

Rust-Themis is a wrapper so it requires the native Themis library to be installed for it to work. Please refer to the quickstart guide for installation instructions.

You can read the docs:

Start with experimenting with the examples or take a look at the tests to get a feel for how Themis can be used.

Licensing

The code is distributed under Apache 2.0 license.

@vixentael
Copy link
Contributor

@karenswry no worries, all these docs are scheduled to be reviewed by you during release preparations.

@ilammy ilammy merged commit 16b0f9e into cossacklabs:master Feb 22, 2019
@ilammy ilammy deleted the rust-readme branch March 28, 2019 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs 📚 Documentation, both offline and online W-RustThemis 🦀 Wrapper: Rust-Themis, Rust API, Cargo crates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants