Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
locka99 committed Apr 12, 2022
1 parent 1bcef6a commit 5f899b6
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 32 deletions.
28 changes: 1 addition & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,33 +49,7 @@ Tutorials / user guides are still work in progress.

The API documentation is generated from the latest published crates. This may be some way behind current development.

<table>
<tr>
<td><b>Client</b></td>
<td><a href="https://docs.rs/opcua-client"><img src="https://docs.rs/opcua-client/badge.svg"></img></a></td>
<td>Client side APIs to connect to an OPC UA server.</td>
</tr>
<tr>
<td><b>Server</b></td>
<td><a href="https://docs.rs/opcua-server"><img src="https://docs.rs/opcua-server/badge.svg"></img></a></td>
<td>Server side APIs to host an OPC UA server, address space, create new nodes, subscriptions.</td>
</tr>
<tr>
<td><b>Crypto</b></td>
<td><a href="https://docs.rs/opcua-crypto"><img src="https://docs.rs/opcua-crypto/badge.svg"></img></a></td>
<td>Security profiles, encryption, hashing, signing / verification, certificate management.</td>
</tr>
<tr>
<td><b>Core</b></td>
<td><a href="https://docs.rs/opcua-core"><img src="https://docs.rs/opcua-core/badge.svg"></img></a></td>
<td>Core functionality shared by client and server - Secure channel, TCP encoding, TCP messages, chunking.</td>
</tr>
<tr>
<td><b>Types</b></td>
<td><a href="https://docs.rs/opcua-types"><img src="https://docs.rs/opcua-types/badge.svg"></img></a></td>
<td>OPC UA core types and binary encoding implementations.</td>
</tr>
</table>
<a href="https://docs.rs/opcua"><img src="https://docs.rs/opcua/badge.svg"></img></a>

# Samples

Expand Down
4 changes: 2 additions & 2 deletions docs/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ session and open connection.
To pull these in, add this to the top of your `main.rs`:

```rust
use opcua_client::prelude::*;
use opcua::client::prelude::*;
```

The `prelude` module contains all of the things a basic client needs.
Expand All @@ -89,7 +89,7 @@ A builder pattern in Rust consists of a number of configuration calls chained to
object we are building.

```rust
use opcua_client::prelude::*;
use opcua::client::prelude::*;

fn main() {
let mut client = ClientBuilder::new()
Expand Down
4 changes: 2 additions & 2 deletions docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ OPC UA for Rust uses convention and idiomatic Rust to minimize the amount of cod
Here is a minimal, functioning server.

```rust
extern crate opcua_server;
extern crate opcua;

use opcua_server::prelude::*;
use opcua::server::prelude::*;

fn main() {
let server: Server = ServerBuilder::new_sample().server().unwrap();
Expand Down
2 changes: 1 addition & 1 deletion docs/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ opcua-server = "0.8.0"
Most of the things you need for the server are exposed with a single import that you can add to the top of your `main.rs`.

```rust
use opcua_server::prelude::*;
use opcua::server::prelude::*;
```

## Create your server
Expand Down

0 comments on commit 5f899b6

Please sign in to comment.