Readme Upate and Release 0.3.0

README.md

@@ -2,7 +2,7 @@
 
 [![Crates.io][crates-badge]][crates-url]
 [![MIT licensed][mit-badge]][mit-url]
-[![Build Status][actions-badge]][actions-url]
+[![Build Status][circleci-badge]][circleci-url]
 [![Rust][version-badge]][version-url]
 [![Docs][docs-badge]][docs-url]
 [![BuyMeaCoffee][bmac-badge]][bmac-url]
@@ -12,8 +12,8 @@
 [crates-url]: https://crates.io/crates/mockd
 [mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
 [mit-url]: https://github.com/jerusdp/mockd/blob/main/LICENSE
-[actions-badge]: https://github.com/jerusdp/mockd/actions/workflows/general.yml/badge.svg?branch=main
-[actions-url]: https://github.com/jerusdp/mockd/actions/workflows/general.yml
+[circleci-badge]: https://circleci.com/gh/jerusdp/mockd/tree/main.svg?style=svg
+[circleci-url]: https://circleci.com/gh/jerusdp/mockd/tree/main
 [version-badge]: https://img.shields.io/badge/rust-1.56.0+-orange.svg
 [version-url]: https://www.rust-lang.org
 [docs-badge]:  https://docs.rs/mockd/badge.svg
@@ -27,5 +27,46 @@ Update to [fakeit](https://github.com/PumpkinSeed/fakeit), a Rust port of the fa
 
 ## Usage
 
-- [Crates.io/mockd](https://crates.io/crates/mockd)
-- [docs.rs](https://docs.rs/mockd)
+The contact info struct contains a phone number and email string.
+
+```rust
+    let info = mockd::contact::info();
+
+    println!("Info: {:#?}", info);
+
+```
+
+Mockd provides mock data in the following categories:
+
+- address
+- animal
+- beer
+- bool_rand
+- color
+- company
+- contact
+- currency
+- data
+- datetime
+- file
+- generator
+- hacker
+- hipster
+- image
+- internet
+- job
+- language
+- log_level
+- misc
+- name
+- password
+- payment
+- person
+- status_code
+- testify
+- unique
+- user_agent
+- vehicle
+- words
+
+Full documentation is available at [docs.rs](https://docs.rs/mockd)