Skip to content

Commit

Permalink
Updated README and library to v0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
wqian94 committed May 20, 2016
1 parent 4491a78 commit 48d0226
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
AuO
AuO version 0.1 (beta)
===
AuO, a browser-based audio recording and editing application. Uses browser-native technologies to avoid third-party dependencies.
AuO, a browser-based audio recording and editing application. Uses browser-native technologies to
avoid third-party dependencies.

Include AuO in any application by including AuO.js. Then, create an instance with

```javascript
const auo = new AuO(link_to_server_url);
```

where link_to_server is the URL to upload audio clips. Ignore this parameter to disable online
saving.

To launch AuO, simply call

```javascript
auo.launch();
```

and the interface should appear. To suspend AuO, click Close or call

```javascript
auo.suspend();
```

to make the interface disappear and prevent resource use. When you are ready to use AuO once more,
call

```javascript
auo.launch();
```

again to relaunch the interface using the same instance.
2 changes: 2 additions & 0 deletions lib/AuO.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
/**
* AuO.js
*
* Version 0.1 (beta) distribution.
*
* Main entry point for the AuO library. Create a new instance of AuO by calling new AuO(). Calling
* launch() adds the instance to the DOM tree, and calling suspend() removes the instance from the
* DOM tree.
Expand Down

0 comments on commit 48d0226

Please sign in to comment.