Skip to content
Browse files

Remove Node.js specific references from README, title, and remove UPG…

…RADING notes
  • Loading branch information...
1 parent cd1d644 commit cd607bbccb205f73f862b060036f39babb4273c0 @lsegal lsegal committed
Showing with 15 additions and 172 deletions.
  1. +1 −2 .yardopts
  2. +13 −45 README.md
  3. +0 −124 UPGRADING.md
  4. +1 −1 doc-src/templates/default/layout/html/footer.erb
View
3 .yardopts
@@ -5,11 +5,10 @@
--no-api private
--api experimental
--no-highlight
---title "AWS SDK for Node.js"
+--title "AWS SDK for JavaScript"
--template-path doc-src/templates
--plugin sitemap
doc-src/*.docs.js
lib/**/*.js
-
README.md
-UPGRADING.md
View
58 README.md
@@ -1,9 +1,19 @@
-# AWS SDK for Node.js [![NPM version](https://badge.fury.io/js/aws-sdk.png)](http://badge.fury.io/js/aws-sdk) [![Build Status](https://travis-ci.org/aws/aws-sdk-js.png?branch=master)](https://travis-ci.org/aws/aws-sdk-js)
+# AWS SDK for JavaScript [![Version](https://badge.fury.io/js/aws-sdk.png)](http://badge.fury.io/js/aws-sdk) [![Build Status](https://travis-ci.org/aws/aws-sdk-js.png?branch=master)](https://travis-ci.org/aws/aws-sdk-js)
-The official JavaScript implementation of the AWS SDK for Node.js.
+The official AWS SDK for JavaScript, available for browsers and mobile devices,
+or Node.js backends
## Installing
+### In the Browser
+
+To use the SDK in the browser, simply add the following script tag to your
+HTML pages:
+
+ <script src="https://sdk.amazonaws.com/js/aws-sdk.min.js"></script>
+
+### In Node.js
+
The preferred way to install the AWS SDK for Node.js is to use the
[npm](http://npmjs.org) package manager for Node.js. Simply type the following
into a terminal window:
@@ -12,49 +22,7 @@ into a terminal window:
npm install aws-sdk
```
-## Usage
-
-After you've installed the SDK, you can require the AWS package in your node
-application using `require`:
-
-```js
-var AWS = require('aws-sdk');
-```
-
-Here is a quick example that makes some requests against Amazon S3 with the SDK:
-
-```js
-// Load the AWS SDK for Node.js
-var AWS = require('aws-sdk');
-
-/**
- * Don't hard-code your credentials!
- * Load them from disk or your environment instead.
- */
-// AWS.config.update({accessKeyId: 'AKID', secretAccessKey: 'SECRET'});
-
-// Instead, do this:
-AWS.config.loadFromPath('./path/to/credentials.json');
-
-// Set your region for future requests.
-AWS.config.update({region: 'us-east-1'});
-
-// Create a bucket using bound parameters and put something in it.
-// Make sure to change the bucket name from "myBucket" to something unique.
-var s3bucket = new AWS.S3({params: {Bucket: 'myBucket'}});
-s3bucket.createBucket(function() {
- var data = {Key: 'myKey', Body: 'Hello!'};
- s3bucket.putObject(data, function(err, data) {
- if (err) {
- console.log("Error uploading data: ", err);
- } else {
- console.log("Successfully uploaded data to myBucket/myKey");
- }
- });
-});
-```
-
-## Getting Started Guide
+## Usage and Getting Started
You can find a getting started guide at:
View
124 UPGRADING.md
@@ -1,124 +0,0 @@
-# @title Upgrading Notes
-
-# Upgrading Notes
-
-## v0.9.7-pre.8 to v0.9.8-pre.9
-
-### `AWS.Request.client` renamed to `AWS.Request.service`
-
-This is a backward incompatible change that is scoped to the `AWS.Request`
-class. If you use this propertry, you can upgrade with the following change:
-
-`request.client.someProperty` to `request.service.someProperty`
-
-### `.Client` and `.client` properties deprecated:
-
-`SERVICE.Client` and `service.client` properties remain for
-backward-compatibility, but are now **deprecated** and no longer documented.
-They may be removed in a 1.0 release. To migrate these properties, change:
-
-`new AWS.S3.Client(...)` to `new AWS.S3(...)`
-
-and/or:
-
-`s3.client.listObjects(...)` to `s3.listObjects(...)`
-
-### New DynamoDB API version
-
-Version 0.9.8-pre.9 of the AWS SDK for Node.js includes a new API version
-(2012-08-10) that contains backward-incompatible changes from the previous API
-version (2011-12-05). By default, the SDK will load the **latest** available
-API version for a service.
-
-#### Migrating operations
-
-In general, the API changes mostly affect the way you create and get items
-from a table, however other operations are also affected. For a more in-depth
-look at the new API, please see the
-[DynamoDB API reference](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/API.html).
-
-##### Creating tables
-
-Creating a table changes from passing these parameters (with `id` as the string
-hash key):
-
-```js
-db.createTable({
- TableName: 'myTable',
- KeySchema: {
- HashKeyElement: { AttributeName: 'id', AttributeType: 'S' }
- },
- ...
-}, function() { ... });
-```
-
-Into the following:
-
-```js
-db.createTable({
- TableName: 'myTable',
- AttributeDefinitions: [
- { AttributeName: 'id', AttributeType: 'S' }
- ],
- KeySchema:[
- { AttributeName: 'id', KeyType: 'HASH' }
- ],
- ...
-}, function() { ... });
-```
-
-##### Getting items
-
-For the `getItem` operation, the arguments mostly change by dropping the
-`HashKeyElement` and `RangeKeyElement` arguments, instead replacing them with
-the actual hash key name in the schema. For example, the following getItem
-call:
-
-```js
-db.getItem({TableName: 'myTable', Key: {HashKeyElement: {S: key}}}, ...);
-```
-
-Turns into this, where `id` is our hash key:
-
-```js
-db.getItem({TableName: 'myTable', Key: {id: {S: key}}}, ...);
-```
-
-Output from these requests will similarly drop `HashKeyElement` parameters
-from output, replacing with the actual hash key name.
-
-#### Locking into the 2011-12-05 API
-
-If you want to continue using the DynamoDB 2011-12-05 API, you can lock your
-API version in your global configuration with `apiVersions`, or directly when
-constructing a service object with the `apiVersion` option:
-
-```js
-// Locking DynamoDB globally in AWS.config
-AWS.config.apiVersions = {
- dynamodb: '2011-12-05'
-};
-
-// Directly on a service object
-var db = new AWS.DynamoDB({apiVersion: '2011-12-05'});
-```
-
-The `apiVersions` option can also be loaded from an external JSON configuration
-file with `AWS.config.loadFromPath()`:
-
-```js
-{
- "region": "us-west-2",
- "accessKeyId": "<YOUR_ACCESS_KEY_ID>",
- "secretAccessKey": "<SECRET>",
- "apiVersions": {
- "dynamodb": "2011-12-05"
- }
-}
-```
-
-This file can be loaded with:
-
-```js
-AWS.config.loadFromPath('path/to/config.json');
-```
View
2 doc-src/templates/default/layout/html/footer.erb
@@ -26,7 +26,7 @@ More info available at http://www.omniture.com -->
</script>
<script language="JavaScript" type="text/javascript">
<!--
- s.prop66='AWS SDK for Node.js';
+ s.prop66='AWS SDK for JavaScript';
s.eVar66='D=c66';
s.prop65='API Reference';
s.eVar65='D=c65';

0 comments on commit cd607bb

Please sign in to comment.
Something went wrong with that request. Please try again.