Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 2 additions & 3 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@ name: Publish Package

# how this workflow will be triggered
on:
push:
branches:
- "master"
release:
types: [published]

permissions:
contents: read
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/tiny-ok-message)

# tiny-ok-message

⚗️ An intentionally small, fetch-based package that is useful for quick API-client experiments. Experimental Package: primarily used for learning purposes.

### 📦 Installation
Expand All @@ -24,16 +25,17 @@ npm install tiny-ok-message
5. TypeScript ready with generated declaration files
6. ESM package output through `dist`
7. Unit tested with Jest and `ts-jest`
8. Github Actions are used for performing trusted publish

### 🔤 Example Usage

```ts
/* node modules */
import { getOkMessage } from 'tiny-ok-message';
import { getOkMessage } from "tiny-ok-message";

/* example */
async function run() {
const response = await getOkMessage({ message: 'hello world' });
const response = await getOkMessage({ message: "hello world" });
console.log(response);
}
await run();
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"utility"
],
"license": "MIT",
"version": "0.9.0",
"version": "0.10.0",
"type": "module",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down
Loading