Skip to content
This repository has been archived by the owner on Sep 18, 2020. It is now read-only.

Commit

Permalink
Merge pull request #23 from csssuf/crates-release
Browse files Browse the repository at this point in the history
Update cargo/readme for initial crates.io release
  • Loading branch information
csssuf authored Apr 4, 2018
2 parents 90840c6 + f3538ee commit eedec9a
Show file tree
Hide file tree
Showing 8 changed files with 93 additions and 3 deletions.
6 changes: 6 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
name = "libyubihsm"
version = "0.1.0"
authors = ["James Forcier <[email protected]>"]
description = "FFI bindings to libyubihsm.so"
repository = "https://github.com/coreos/libyubihsm-rs"
readme = "README.md"
keywords = ["yubihsm", "hsm"]
categories = ["external-ffi-bindings", "cryptography", "hardware-support"]
license = "Apache-2.0"

[build-dependencies]
bindgen = "0.32"
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ created through a `Connector`, which connects to a running instance of `yubihsm-
is included in the SDK\). Once a `Session` has been obtained, it can be used for cryptographic
functions provided by the YubiHSM2.

libyubihsm-rs is not currently published on [crates](https://crates.io). It can be added as a
dependency by adding the following to your `Cargo.toml`:
libyubihsm-rs is published on [crates](https://crates.io). It can be added as a dependency by adding
the following to your `Cargo.toml`:
```
[dependencies.libyubihsm]
git = "https://github.com/coreos/libyubihsm-rs"
version = "0.1"
```

## Documentation
Expand Down
14 changes: 14 additions & 0 deletions src/connector.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
// Copyright 2018 CoreOS, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use types::*;
use session::Session;

Expand Down
14 changes: 14 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
// Copyright 2018 CoreOS, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![allow(unknown_lints)]

#[macro_use]
Expand Down
14 changes: 14 additions & 0 deletions src/session.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
// Copyright 2018 CoreOS, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use types::*;

use failure::Error;
Expand Down
14 changes: 14 additions & 0 deletions src/tests.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
// Copyright 2018 CoreOS, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use types::*;

#[test]
Expand Down
14 changes: 14 additions & 0 deletions src/types.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
// Copyright 2018 CoreOS, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use failure::Error;
use yubihsm_sys::*;

Expand Down
14 changes: 14 additions & 0 deletions src/yubihsm.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
// Copyright 2018 CoreOS, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use connector::ConnectorBuilder;
use types::*;

Expand Down

0 comments on commit eedec9a

Please sign in to comment.