Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch from Mocha to Jest and bump the package version to 1.0.2 #1

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Switch from Mocha to Jest and bump the package version to 1.0.2 #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bc6fd89
1.0.0-1
awk Oct 10, 2018
909883e
Remove private field from package.json.
awk Oct 10, 2018
7625602
1.0.0-2
awk Oct 10, 2018
9db2380
Add travis build badge and update links in README.md
awk Oct 10, 2018
c4795ea
1.0.0
awk Oct 10, 2018
fc8c0e7
Switch from mocha to jest - avoids any security issues with the old v…
awk Apr 28, 2020
d6654c4
1.0.1
awk Apr 28, 2020
83dbae3
1.0.2
awk Apr 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Onshape API Key Sample Apps
# Onshape API Key encoding package

Simple Node.js and Python apps to demonstrate API key usage
[![Build](https://travis-ci.org/onshape-public/node-apikey.svg?branch=master)](https://travis-ci.org/onshape-public/node-apikey)

Make HTTP requests to Onshape using an API Key.

---

### Getting Started

Please see the [node](https://github.com/onshape/apikey/tree/master/Node) and
[python](https://github.com/onshape/apikey/tree/master/python) folders for
instructions on working with each of the applications.
Please see the [node examples](https://github.com/onshape-public/apikey/tree/master/Node) for further examples of using this package.

### Why API Keys?

Expand Down Expand Up @@ -40,7 +40,7 @@ application:
1. Create and manage your API key pairs from the [Developer Portal](https://dev-portal.onshape.com);
note that the secret will only be displayed once! Keep it somewhere safe.

2. Now that you have a key pair, see [below](#generating-a-request-signature) for
2. Now that you have a key pair, see [below](#signing-an-http-request) for
information on signing your requests to use our API.

Once you have your access key and secret, you will want to avoid giving others access to them since they're tied directly to your personal Onshape account. Think of your API key as a username and password pair. Therefore, you should avoid placing them directly in the code for your application, especially if others might see it. The samples use a separate configuration file that you yourself will need to create that will contain this information, but there are other ways to keep the access key and secret safe, like setting them as environment variables.
Expand Down
Loading