Fix examples in docs (#201)

* Add stellar-xdr bin * Expose all versions of xdr * Update CLI to use multiple channels * fmt * Use makefile in tests * simplify build * undo * fix version * update readme * fix docs * fix * fix docs * fix doc * simplify example * fix * fix
stellar · Nov 30, 2022 · 7532610 · 7532610
1 parent 3283038
commit 7532610
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ and is receiving breaking changes frequently.**
 To use the library, include in your toml:
 
 ```toml
-stellar-xdr = { version = "...", default-features = true, features = [...] }
+stellar-xdr = { version = "...", default-features = true, features = [] }
 ```
 
 ##### Features
@@ -66,24 +66,28 @@ the root of the crate.
 
 To use the CLI:
 
-```toml
+```console
 cargo install --locked stellar-xdr --version ... --features cli
 ```
 
 ##### Examples
 
 Parse a `TransactionEnvelope`:
-```rust
-echo -n 'AAAAA...' | stellar-xdr decode --type TransactionEnvelope
+```console
+stellar-xdr decode --type TransactionEnvelope << -
+AAAAA...
+-
 ```
 
 Parse a `ScSpecEntry` stream from a contract:
-```rust
-echo -n 'AAAAA...' | stellar-xdr +next decode --type ScSpecEntry --input stream-base64 --output json-formatted
+```console
+stellar-xdr +next decode --type ScSpecEntry --input stream-base64 --output json-formatted << -
+AAAAA...
+-
 ```
 
 Parse a `BucketEntry` framed stream from a bucket file:
-```rust
+```console
 stellar-xdr decode --type BucketEntry --input stream-framed --output json-formatted bucket.xdr
 ```
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -21,7 +21,7 @@
 //! To use the library, include in your toml:
 //!
 //! ```toml
-//! stellar-xdr = { version = "...", default-features = true, features = [...] }
+//! stellar-xdr = { version = "...", default-features = true, features = [] }
 //! ```
 //!
 //! #### Features
@@ -68,20 +68,24 @@
 //!
 //! To use the CLI:
 //!
-//! ```toml
+//! ```console
 //! cargo install --locked stellar-xdr --version ... --features cli
 //! ```
 //!
 //! #### Examples
 //!
 //! Parse a `TransactionEnvelope`:
 //! ```console
-//! echo -n 'AAAAA...' | stellar-xdr decode --type TransactionEnvelope
+//! stellar-xdr decode --type TransactionEnvelope << -
+//! AAAAA...
+//! -
 //! ```
 //!
 //! Parse a `ScSpecEntry` stream from a contract:
 //! ```console
-//! echo -n 'AAAAA...' | stellar-xdr +next decode --type ScSpecEntry --input stream-base64 --output json-formatted
+//! stellar-xdr +next decode --type ScSpecEntry --input stream-base64 --output json-formatted << -
+//! AAAAA...
+//! -
 //! ```
 //!
 //! Parse a `BucketEntry` framed stream from a bucket file: