Skip to content

Commit

Permalink
add initial readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wobsoriano committed Jul 17, 2022
1 parent e339693 commit e8e60a0
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
# bun starter
# bunbot

## Getting Started
Native cross-platform GUI automation for the Bun runtime.

Click the [Use this template](https://github.com/wobsoriano/bun-lib-starter/generate) button to create a new repository with the contents starter.
## Install

OR
```bash
bun add bunbot
```

Run `bun create wobsoriano/bun-lib-starter ./my-lib`.
## Usage

## Features
```ts
import { scrollMouse } from 'bunbot'

- [bun](https://github.com/oven-sh/bun) as package manager and task runner
- Bundle with [tsup](https://github.com/egoist/tsup)
- Release with [bumpp](https://github.com/antfu/bumpp)
- Beautiful changelogs with [changelogithub](https://github.com/antfu/changelogithub)
scrollMouse(10, 'up')
scrollMouse(20, 'right')
```

## License

Expand Down

0 comments on commit e8e60a0

Please sign in to comment.