Skip to content

Commit b6e0cca

Browse files
authored
chore: final prep for v1.0.0 release (#39)
* ci: prep for v1.0.0 release * chore: pin dependency versions and fix dependabot alerts * docs: finalize docs before initial release * chore: enable lint-staged for js and ts files
1 parent cd03234 commit b6e0cca

File tree

4 files changed

+714
-682
lines changed

4 files changed

+714
-682
lines changed

.github/workflows/publish_release.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ jobs:
4646
with:
4747
token: ${{ secrets.NPM_ACCESS_TOKEN }}
4848
access: public
49-
dry-run: true
5049

5150
- uses: act10ns/slack@v1
5251
with:

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ The Abound Node SDK supports all Abound API endpoints. See the [API Documentatio
88

99
### Requirements
1010

11+
You can start to integrate the Abound Node library into your solution as soon as you [create an account with Abound][developer-dashboard-signup] and [obtain your API keys][developer-dashboard-keys].
12+
1113
### Installation
1214

1315
Install the SDK with:
@@ -516,6 +518,18 @@ $ npx xo
516518
$ npx xo --fix
517519
```
518520

521+
Compile:
522+
523+
```sh
524+
$ npm run compile
525+
```
526+
527+
Install husky:
528+
529+
```sh
530+
$ npx husky install
531+
```
532+
519533
Publish artifacts locally:
520534

521535
Install `yalc`:
@@ -526,7 +540,7 @@ $ npm i yalc -g
526540
$ yarn global add yalc
527541
```
528542

529-
Compile + Build the SDK:
543+
Build the SDK:
530544

531545
```sh
532546
$ npm run build
@@ -548,3 +562,4 @@ Install the local artifacts:
548562
[api-reference]: https://docs.withabound.com/reference
549563
[developer-dashboard]: https://dashboard.withabound.com
550564
[developer-dashboard-keys]: https://dashboard.withabound.com/keys
565+
[developer-dashboard-signup]: https://dashboard.withabound.com/signup

0 commit comments

Comments
 (0)