Permalink
Browse files

README: minor improvements

Formatting, grammar, punctuation, some editing
  • Loading branch information...
1 parent bf543b2 commit 56092c9f4f9ea247ddb4bc13888efe8a787e9ccb @pje pje committed Mar 19, 2013
Showing with 29 additions and 22 deletions.
  1. +29 −22 README.md
View
@@ -1,10 +1,9 @@
-# SoundCloud JavaScript SDk
+# SoundCloud JavaScript SDK
## Introduction
-The SoundCloud JavaScript SDK lets you easily integrate SoundCloud into your website or web app.
-Its full documentation can be found [here](http://developers.soundcloud.com/docs/javascript-sdk).
-In most case it's highly recommended that you use the hosted version from [http://connect.soundcloud.com/sdk.js](http://connect.soundcloud.com/sdk.js) in your website. This README provides development related informations.
+The [SoundCloud JavaScript SDK](http://developers.soundcloud.com/docs/javascript-sdk) lets you easily integrate SoundCloud into your website or web app.
+**In most cases it's highly recommended that you use the hosted version** from [http://connect.soundcloud.com/sdk.js](http://connect.soundcloud.com/sdk.js) in your website. This README provides development-related information.
## Dependencies
@@ -13,34 +12,42 @@ In most case it's highly recommended that you use the hosted version from [http:
- - uglify-js
- - jslint
-## Usage
+## Development
-To checkout the repository locally and to initialize all submodules in vendor run:
+To check out the repository locally and initialize all submodules in `vendor/`, run:
- $ git clone git@github.com:soundcloud/soundcloud-javascript.git
- $ cd soundcloud-javascript
- $ git submodule update --init
- $ npm install
+```bash
+$ git clone git@github.com:soundcloud/soundcloud-javascript.git
+$ cd soundcloud-javascript
+$ git submodule update --init
+$ npm install
+```
-To build the release version in _build/_ just run:
+To build the release version in `build/`, just run:
- $ make build
+```bash
+$ make build
+```
-To run the tests or use the sdk.js you can run _bin/server_ in either ./ or in ./build.
-The sdk.js in ./ will automatically compile all the coffeescripts in ./src on the fly when loaded.
-To make the sdk.js fully work it needs to be accessed via http://connect.soundcloud.dev instead of http://localhost:9090
+To run the tests or use `sdk.js`, run this from either the top level of your repo or `build/`:
+
+```bash
+$ bin/server
+```
+
+The file `sdk.js` will automatically compile all coffeescript files in `src/` on the fly when loaded.
+For `sdk.js` to work **it must be accessed from `http://connect.soundcloud.dev`** instead of `http://localhost:9090`.
## Testing
-To run the tests just start an HTTP server (for example "$ ponyhost server") in the project root and navigate to http://yourhost/test/test.html.
+To run the tests, just start an HTTP server in the project root and navigate to `http://yourhost/test/test.html`.
In development mode the tests will automatically compile the coffeescript on each reload.
In build mode the tests will laod the compiled sdk.js.
## Repository Structure
-- _build/_ will provide the compiled CoffeeScript as it's hosted on [http://connect.soundcloud.com](http://connect.soundcloud.com)
-- _src/_ the coffee script source code
-- _vendor/_ includes git submodules of external projects
-- _test/_ tests
-- _examples/_ examples
-
+- `build/` — contains compiled JS (as it's hosted on [http://connect.soundcloud.com](http://connect.soundcloud.com))
+- `src/` — contains coffeescript source code
+- `vendor/` — includes git submodules of external projects
+- `test/` — tests live here
+- `examples/` — here there be examples

0 comments on commit 56092c9

Please sign in to comment.