From 645965def16743d53dc34d03ab0481d85e576ed0 Mon Sep 17 00:00:00 2001 From: Jordan Eldredge Date: Wed, 28 Mar 2018 21:50:33 -0700 Subject: [PATCH] Spelling is hard. --- CHANGELOG.md | 2 +- README.md | 2 +- docs/{ussage.md => usage.md} | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) rename docs/{ussage.md => usage.md} (97%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 48169398..29a34b54 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ * Added: `winamp.appendTracks()`. * Added: `winamp.setTracksToPlay()`. * Changed: We no-longer try to center on window resize. -* Meta: Added real documentation! +* Meta: Added real [documentation](./docs/usage.md)! * Meta: Remove lots of garbage from the NPM build. ## Prehistory diff --git a/README.md b/README.md index 6c1f1321..cc2c2185 100755 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Check out this Twitter thread for an illustrated list of features: https://twitt I've tried to make it possible to include Winamp2-js in your own project. -See the [ussage documentation](./docs/ussage.md) for more information. +See the [usage documentation](./docs/usage.md) for more information. ## Development diff --git a/docs/ussage.md b/docs/usage.md similarity index 97% rename from docs/ussage.md rename to docs/usage.md index a4900254..1b8141c5 100644 --- a/docs/ussage.md +++ b/docs/usage.md @@ -28,8 +28,8 @@ Create a DOM element somewhere in your HTML document. This will eventually conta ```JavaScript import Winamp from 'winamp2-js'; -// Or, if you installed via a script tag: -// const Winamp = window.winamp2-js; +// Or, if you installed via a script tag, `Winamp` is avaliable on the global `window`: +// const Winamp = window.winamp2js; // Check if Winamp is supported in this browser if(!Winamp.browserIsSupported()) {