Skip to content

Commit

Permalink
update readme and makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
rkeur7 committed Nov 21, 2024
1 parent 512b6e7 commit e7271cf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 16 deletions.
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
BUILD_DIR=./build/
LOCAL_SPEC_FILE=${BUILD_DIR}public-api.yaml

build-nix:
./gradlew publishToMavenLocal -Pskip.signing

build-windows:
gradlew.bat publishToMavenLocal -Pskip.signing

check: test

test:
Expand Down
22 changes: 6 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ your own token.
For example.
```
Shippo sdk = Shippo.builder()
.apiKeyHeader("shippo_test_595d9cb0c0e14497bf07e75ecfec6c6d")
.apiKeyHeader("<YOUR_API_KEY_HERE>")
.build();
```

Expand Down Expand Up @@ -55,20 +55,6 @@ Maven:
<version>1.0.0-beta</version>
</dependency>
```

### How to build
After cloning the git repository to your file system you can build the SDK artifact from source to the `build` directory by running `./gradlew build` on *nix systems or `gradlew.bat` on Windows systems.

If you wish to build from source and publish the SDK artifact to your local Maven repository (on your filesystem) then use the following command (after cloning the git repo locally):

On *nix:
```bash
./gradlew publishToMavenLocal -Pskip.signing
```
On Windows:
```bash
gradlew.bat publishToMavenLocal -Pskip.signing
```
<!-- End SDK Installation [installation] -->

## SDK Example Usage
Expand Down Expand Up @@ -285,4 +271,8 @@ looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
## About Shippo
Connect with multiple different carriers, get discounted shipping labels, track parcels, and much more with just one integration.
You can use your own carrier accounts or take advantage of our discounted rates with the Shippo carrier accounts.
Using Shippo makes it easy to deal with multiple carrier integrations, rate shopping, tracking and other parts of the shipping workflow.
We provide the API and web app for all your shipping needs.

0 comments on commit e7271cf

Please sign in to comment.