Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

Commit

Permalink
Updated READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
Justintime50 committed Sep 17, 2020
1 parent 163ffcd commit 261f488
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
<div align="center">

# EasyPost CLI

Easily interact with the EasyPost API via the CLI.
The EasyPost API on the CLI.

[![Build Status](https://travis-ci.com/Justintime50/easypost-cli.svg?branch=master)](https://travis-ci.com/Justintime50/easypost-cli)
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)
[![Licence](https://img.shields.io/github/license/justintime50/easypost-cli)](LICENSE)

<img src="assets/showcase.png" alt="Showcase">

</div>

Written in pure `Bash` and only requiring `cURL`, the EasyPost CLI is portable and simple to use. View the official [EasyPost documentation](https://www.easypost.com/docs/api) for more information about the API or visit the [EasyPost CLI website](https://justintime50.github.io/easypost-cli).

Expand Down Expand Up @@ -68,3 +74,7 @@ For a full breakdown of how the EasyPost CLI works under the hood, see the accom
# Build the EasyPost CLI, passing in the version number as a parameter
./build.sh 1.1.2 bash
```

## Disclaimer

This project is not endorsed or maintained by EasyPost.
Binary file added assets/showcase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 11 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# EasyPost CLI Home

Here you will find all you need to know about the [EasyPost CLI]((https://github.com/Justintime50/easypost-cli)).
> The EasyPost API on the CLI.
**What Can it Do?**

At a high level, the EasyPost CLI can:
- Create and retrieve addresses, parcels, insurance, shipments, pickups, trackers, webhooks, batches, and more
- Buy labels, refund shipments, and rate carriers
- Create and retrieve custom reports
- Lookup EasyPost account details, create child users, and more

Check out the project on [GitHub]((https://github.com/Justintime50/easypost-cli)).

## User Documentation

Expand Down

0 comments on commit 261f488

Please sign in to comment.