Skip to content

Commit

Permalink
update README files for new workspace layout and new crates
Browse files Browse the repository at this point in the history
  • Loading branch information
decathorpe committed Jun 25, 2022
1 parent d90d586 commit ad4a447
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ The project is split into six crates:
- `dxr_server`: generic XML-RPC server functionality
- `dxr_server_axum`: XML-RPC server implementation using `axum`

It is recommended to only add a direct dependency on `dxr` and to enable the required features.

### Why another crate for XML-RPC?

Searching for `xml-rpc` on crates.io yields a few results, but they all did not fit my
Expand Down
13 changes: 13 additions & 0 deletions dxr_client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# DXR: declarative XML-RPC (client implementation)

[![crates.io](https://img.shields.io/crates/v/dxr_client.svg)](https://crates.io/crates/dxr_client/)
[![crates.io](https://img.shields.io/crates/d/dxr_client.svg)](https://crates.io/crates/dxr_client/)
[![crates.io](https://img.shields.io/crates/l/dxr_client.svg)](https://crates.io/crates/dxr_client/)
[![docs.rs](https://docs.rs/dxr_client/badge.svg)](https://docs.rs/dxr_client/)

The dxr project provides crates for writing XML-RPC API clients and servers in Rust.

This crate contains an implementation of an `async` XML-RPC client using `reqwest`. The client
functionality is re-exported from the `dxr` crate when the `client` feature is enabled, so
this crate should be considered an internal implementation detail, and never be imported or
used directly.
12 changes: 12 additions & 0 deletions dxr_server/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DXR: declarative XML-RPC (server implementation)

[![crates.io](https://img.shields.io/crates/v/dxr_server.svg)](https://crates.io/crates/dxr_server/)
[![crates.io](https://img.shields.io/crates/d/dxr_server.svg)](https://crates.io/crates/dxr_server/)
[![crates.io](https://img.shields.io/crates/l/dxr_server.svg)](https://crates.io/crates/dxr_server/)
[![docs.rs](https://docs.rs/dxr_server/badge.svg)](https://docs.rs/dxr_server/)

The dxr project provides crates for writing XML-RPC API clients and servers in Rust.

This crate contains a basic implementation of an `async` XML-RPC server. The server functionality
is re-exported from the `dxr` crate when the `server` feature is enabled, so this crate should be
considered an internal implementation detail, and never be imported or used directly.
12 changes: 12 additions & 0 deletions dxr_server_axum/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DXR: declarative XML-RPC (axum server)

[![crates.io](https://img.shields.io/crates/v/dxr_server_axum.svg)](https://crates.io/crates/dxr_server_axum/)
[![crates.io](https://img.shields.io/crates/d/dxr_server_axum.svg)](https://crates.io/crates/dxr_server_axum/)
[![crates.io](https://img.shields.io/crates/l/dxr_server_axum.svg)](https://crates.io/crates/dxr_server_axum/)
[![docs.rs](https://docs.rs/dxr_server_axum/badge.svg)](https://docs.rs/dxr_server_axum/)

The dxr project provides crates for writing XML-RPC API clients and servers in Rust.

This crate contains an implementation of an `async` XML-RPC server using `axum`. This functionality
is re-exported from the `dxr` crate when the `server-axum` feature is enabled, so this crate should be
considered an internal implementation detail, and never be imported or used directly.
12 changes: 12 additions & 0 deletions dxr_shared/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DXR: declarative XML-RPC (shared implementation details)

[![crates.io](https://img.shields.io/crates/v/dxr_shared.svg)](https://crates.io/crates/dxr_shared/)
[![crates.io](https://img.shields.io/crates/d/dxr_shared.svg)](https://crates.io/crates/dxr_shared/)
[![crates.io](https://img.shields.io/crates/l/dxr_shared.svg)](https://crates.io/crates/dxr_shared/)
[![docs.rs](https://docs.rs/dxr_shared/badge.svg)](https://docs.rs/dxr_shared/)

The dxr project provides crates for writing XML-RPC API clients and servers in Rust.

This crate contains implementations of type conversions between XML strings, XML-RPC values, and
the corresponding Rust types. This functionality should be considered an internal implementation
detail, and never be imported or used directly.

0 comments on commit ad4a447

Please sign in to comment.