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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Fake product demos on a landing page usually rot. The cursor is on one timeline,
Busker gets rid of the second timeline. You give it a list of places the cursor goes, it glides there and **really clicks the element**, and your own handlers change the page. Nothing is timed except the pauses, so there is nothing to keep in sync.

```typescript
import {busk} from 'busker';
import 'busker/busker.css';
import {busk} from '@logfox/busker';
import '@logfox/busker/busker.css';

busk(document.querySelector('.app'), {
scene: 'home',
Expand All @@ -39,7 +39,7 @@ Zero dependencies, about 4kB, no build step, no framework.
## Quick start

```bash
npm i busker
npm i @logfox/busker
```

[Getting started](src/content/docs/getting-started.md) is a working demo in four steps.
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "busker",
"name": "@logfox/busker",
"version": "0.0.0",
"description": "Scripted cursor demos that really click. Drive a fake product UI with a routine, not a stopwatch.",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/api-reference.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# API reference

```typescript
import {busk} from 'busker';
import {busk} from '@logfox/busker';

const show = busk(root, routine);
```
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## 1. Install

```bash
npm i busker
npm i @logfox/busker
```

Busker has no dependencies and runs in the browser. It ships types, and works with any framework or none — it only ever touches the element you hand it.
Expand Down Expand Up @@ -36,8 +36,8 @@ A mock is ordinary markup. Busker needs three things from it, all `data-` attrib
## 3. Put on a show

```typescript title="main.ts"
import {busk} from 'busker';
import 'busker/busker.css';
import {busk} from '@logfox/busker';
import '@logfox/busker/busker.css';

const root = document.querySelector<HTMLElement>('.app');

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/styling.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
`busker.css` is optional. It styles the cursor, the ripple, the pointer affordance, the miss hint, and scene switching &mdash; about 100 lines, all scoped to `.busker`.

```typescript
import 'busker/busker.css';
import '@logfox/busker/busker.css';
```

Or copy it into your own stylesheet and edit it. There is nothing clever in there.
Expand Down
Loading