Skip to content

Commit

Permalink
chore: add example to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
katlyn committed May 23, 2024
1 parent 1a302c1 commit 68573d7
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# fops

Simulate the best creature ever: the fops.

```ts
import fops from "@fops/fops";

// Cuddle with the fops
fops.cuddle()
```
7 changes: 4 additions & 3 deletions index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@
export class Fops {
/** Boop the fops */
boop (): string {
return "*blep*"
return "*blep*";
}

/** Cuddle the fops */
cuddle (): string {
return ">///<"
return ">///<";
}

/** Pat the fops */
pat (): string {
return "^w^"
return "^w^";
}
}

/** A ready to play with Fops */
const defaultInstance: Fops = new Fops();
export default defaultInstance;
2 changes: 1 addition & 1 deletion jsr.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@fops/fops",
"version": "0.0.2",
"version": "0.0.3",
"exports": "./index.ts"
}

0 comments on commit 68573d7

Please sign in to comment.