From e8e60a026643711782b9051565cdcef314c9f851 Mon Sep 17 00:00:00 2001 From: Robert Soriano Date: Sat, 16 Jul 2022 19:05:35 -0700 Subject: [PATCH] add initial readme --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9b94f20..1cc69eb 100644 --- a/README.md +++ b/README.md @@ -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