From 6af67cd1958eb8f86bd359c528735abe57873fd2 Mon Sep 17 00:00:00 2001
From: Ritesh Chitlangi <ritesh@ayravat.com>
Date: Tue, 27 Jul 2021 04:05:46 +0800
Subject: [PATCH] added README.md to epp-client package as well for crates.io

---
 epp-client/README.md | 94 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 epp-client/README.md

diff --git a/epp-client/README.md b/epp-client/README.md
new file mode 100644
index 0000000..9e616e7
--- /dev/null
+++ b/epp-client/README.md
@@ -0,0 +1,94 @@
+# EPP (Extensible Provisioning Protocol) Library for Domain Registration and Management
+
+## Description
+
+epp-client is a client library written in Rust for Internet domain registration and management for domain registrars.
+
+It supports the following basic Domain, Contact, Host, and Message management calls, with plans to add more calls
+and other EPP extensions in the future, and to eventually be RFC compliant with the EPP protocol.
+
+- Domain Check - `EppDomainCheck`
+- Domain Create - `EppDomainCreate`
+- Domain Info - `EppDomainInfo`
+- Domain Update - `EppDomainUpdate`
+- Domain Delete - `EppDomainDelete`
+- Domain Renew - `EppDomainRenew`
+- Domain Transfer - `EppDomainTransferRequest`
+
+- Contact Check - `EppContactCheck`
+- Contact Create - `EppContactCreate`
+- Contact Info - `EppContactInfo`
+- Contact Update - `EppContactUpdate`
+- Contact Delete - `EppContactDelete`
+
+- Host Check - `EppHostCheck`
+- Host Create - `EppHostCreate`
+- Host Info - `EppHostInfo`
+- Host Update - `EppHostUpdate`
+- Host Delete - `EppHostDelete`
+
+- Message Poll - `EppMessagePoll`
+- Message Ack - `EppMessageAck`
+
+## Prerequisites
+
+To use the library, you must have an `epp-client/epp-client.toml` config file with the relevant registry
+credentials in your default user configuration directory on your OS. For Linux, this is the `XDG user directory`,
+usually located at `$HOME/.config` or defined by the `XDG_CONFIG_HOME` environment variable.
+
+An example config looks like this:
+
+```toml
+[registry.verisign
+host = 'epp.verisign-grs.com'
+port = 700
+username = 'username'
+password = 'password'
+# service extensions
+ext_uris = [
+
+[registry.verisign.tls_files
+# the full client certificate chain in PEM format
+cert_chain = '/path/to/certificate/chain/pemfile'
+# the RSA private key for your certificate
+key = '/path/to/private/key/pemfile'
+```
+
+## Operation
+
+Once the config is set correctly, you can create a mut variable of type [`EppClient`
+with the domain registry
+
+```rust
+use epp_client::EppClient;
+use epp_client::epp::{EppDomainCheck, EppDomainCheckResponse};
+use epp_client::epp::generate_client_tr_id;
+
+#[tokio::main
+async fn main() {
+    // Create an instance of EppClient, specifying the name of the registry as in
+    // the config file
+    let mut client = match EppClient::new("verisign").await {
+        Ok(client) => client,
+        Err(e) => panic!("Failed to create EppClient: {}",  e)
+    };
+
+    // Make a domain check call, which returns an object of type EppDomainCheckResponse
+    // that contains the result of the call
+    let domain_check = EppDomainCheck::new(
+        vec!["eppdev.com", "eppdev.net"
+        generate_client_tr_id(&client).as_str()
+    );
+
+    let response = client.transact::<_, EppDomainCheckResponse>(&domain_check).await.unwrap();
+
+    // print the availability results
+    response.data.res_data.unwrap().check_data.domain_list
+        .iter()
+        .for_each(|chk| println!("Domain: {}, Available: {}", chk.domain.name, chk.domain.available));
+}
+```
+
+## Request
+
+Currently I don't have access to a registry's OT&E account to do extensive testing. I am using [hexonet's EPP Gateway](https://wiki.hexonet.net/wiki/EPP_Gateway) for testing, but access to a registry's OT&E account would be very helpful, so if anyone can help me out with one it would be very helpful!
\ No newline at end of file