char/matrix-rust-sdk
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs(qrcode): Use the readme for the crate docs

Browse source
This commit is contained in:
Damir Jelić 2021-09-09 20:26:09 +02:00
parent b94faa3121
commit 4c8412f4a1
2 changed files with 6 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
matrix_qrcode/README.md
View file

@ -1,28 +1,16 @@
[![Build Status](https://img.shields.io/travis/matrix-org/matrix-rust-sdk.svg?style=flat-square)](https://travis-ci.org/matrix-org/matrix-rust-sdk)
[![codecov](https://img.shields.io/codecov/c/github/matrix-org/matrix-rust-sdk/master.svg?style=flat-square)](https://codecov.io/gh/matrix-org/matrix-rust-sdk)
[![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)
[![#matrix-rust-sdk](https://img.shields.io/badge/matrix-%23matrix--rust--sdk-blue?style=flat-square)](https://matrix.to/#/#matrix-rust-sdk:matrix.org)
# matrix-qrcode
**matrix-qrcode** is a crate to easily generate and parse QR codes for **matrix-qrcode** is a crate to easily generate and parse QR codes for
interactive verification using [QR codes] in Matrix. interactive verification using [QR codes] in Matrix.
[Matrix]: https://matrix.org/
[Rust]: https://www.rust-lang.org/
[QR codes]: https://spec.matrix.org/unstable/client-server-api/#qr-codes
## Usage ## Usage
This is probably not the crate you are looking for, it's used internally in the This is probably not the crate you are looking for, it's used internally in the
matrix-rust-sdk. [matrix-sdk].
If you still want to play with QR codes, here are a couple of helpful examples. If you still want to play with QR codes, here are a couple of helpful examples.
### Decode an image ### Decode an image
```rust ```rust,no_run
use image; use image;
use matrix_qrcode::{QrVerificationData, DecodingError}; use matrix_qrcode::{QrVerificationData, DecodingError};
@ -36,7 +24,7 @@ fn main() -> Result<(), DecodingError> {
### Encode into a QR code ### Encode into a QR code
```rust ```rust,no_run
use matrix_qrcode::{QrVerificationData, DecodingError}; use matrix_qrcode::{QrVerificationData, DecodingError};
use image::Luma; use image::Luma;
@ -56,7 +44,5 @@ fn main() -> Result<(), DecodingError> {
} }
``` ```
[matrix-sdk]: https://github.com/matrix-org/matrix-rust-sdk/
## License [QR codes]: https://spec.matrix.org/unstable/client-server-api/#qr-codes
[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)

19
matrix_qrcode/src/lib.rs
View file

@ -12,24 +12,7 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
//! This crate implements methods to parse and generate QR codes that are used #![doc = include_str!("../README.md")]
//! for interactive verification in [Matrix](https://matrix.org/).
//!
//! It implements the QR format defined in the Matrix [spec].
//!
//! [spec]: https://spec.matrix.org/unstable/client-server-api/#qr-code-format
//!
//! ```no_run
//! # use matrix_qrcode::{QrVerificationData, DecodingError};
//! # fn main() -> Result<(), DecodingError> {
//! use image;
//!
//! let image = image::open("/path/to/my/image.png").unwrap();
//! let result = QrVerificationData::from_image(image)?;
//! # Ok(())
//! # }
//! ```
#![cfg_attr(feature = "docs", feature(doc_cfg))] #![cfg_attr(feature = "docs", feature(doc_cfg))]
#![deny( #![deny(
missing_debug_implementations, missing_debug_implementations,