Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Fixed the README.md #23

Merged
merged 1 commit into from

2 participants

Joost de Nijs Jason Cooke [Microsoft]
Joost de Nijs

Switched from HTML to Markdown and added Tables to the Features section

Jason Cooke [Microsoft] jcookems merged commit 15a260e into from
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
Showing with 121 additions and 123 deletions.
  1. +121 −123 README.md
244 README.md
View
@@ -1,137 +1,135 @@
-<h1>Windows Azure SDK for Java</h1>
-<p>This SDK allows you to build Windows Azure applications in Java that allow
+#Windows Azure SDK for Java
+
+This SDK allows you to build Windows Azure applications in Java that allow
you to take advantage of Azure scalable cloud computing resources: table and blob
-storage, messaging through Service Bus.</p>
-
-<p>For documentation please see the <a href="http://www.windowsazure.com/en-us/develop/java/">
-Windows Azure Java Developer Center</a></p>
-
-<h1>Features</h1>
-<ul>
-<li>Blob
-<ul>
-<li>Create/Read/Update/Delete Blobs</li>
-</ul></li>
-<li>Queue
-<ul>
-<li>Create/Delete Queues</li>
-<li>Insert/Peek Queue Messages</li>
-<li>Advanced Queue Operations</li>
-</ul></li>
-<li>Service Bus
-<ul>
-<li>Use either the Queue or Topic/Subscription Model</li>
-</ul></li>
-<li>Service Runtime
-<ul>
-<li>Retrieve information about the state of your Azure Compute instances</li>
-</ul></li>
-</ul>
-
-<h1>Getting Started</h1>
-<h2>Download</h2>
-<h3>Option 1: Via Git</h3>
-<p>To get the source code of the SDK via git just type:<br/>
-<pre>git clone git://github.com/WindowsAzure/azure-sdk-for-java.git
-cd ./azure-sdk-for-java
-mvn compile</pre>
-
-<h3>Option 2: Via Maven</h3>
-<p>To get the binaries of this library as distributed by Microsoft, ready for use
-within your project you can also have them installed by the Java package manager Maven.<br/>
-<pre>&lt;dependency&gt;
- &lt;groupId&gt;com.microsoft.windowsazure&lt;/groupId&gt;
- &lt;artifactId&gt;microsoft-windowsazure-api&lt;/artifactId&gt;
- &lt;version&gt;0.1.0&lt;/version&gt;
-&lt;/dependency&gt;</pre></p>
-
-<h2>Minimum Requirements</h2>
-<ul>
-<li>Java 1.6</li>
-<li>(Optional) Maven</li>
-</ul>
-
-<h2>Usage</h2>
-<p>To use this SDK to call Windows Azure services, you need to first create an
+storage, messaging through Service Bus.
+
+For documentation please see the [Windows Azure Java Developer Center](http://www.windowsazure.com/en-us/develop/java/)
+
+#Features
+* Blob
+ * Create/Read/Update/Delete Blobs
+* Queue
+ * Create/Delete Queues
+ * Insert/Peek Queue Messages
+ * Advanced Queue Operations
+* Service Bus
+ * Use either the Queue or Topic/Subscription Model
+* Service Runtime
+ * Retrieve information about the state of your Azure Compute instances
+* Table
+ * Manage Tables
+ * Work with Table Entities (CRUD)
+ * Entity Group Transactions (Batch)
+
+#Getting Started
+
+##Download
+###Option 1: Via Git
+
+To get the source code of the SDK via git just type:
+
+ git clone git://github.com/WindowsAzure/azure-sdk-for-java.git
+ cd ./azure-sdk-for-java
+ mvn compile
+
+###Option 2: Via Maven
+
+To get the binaries of this library as distributed by Microsoft, ready for use
+within your project you can also have them installed by the Java package manager Maven.
+
+ <dependency>
+ <groupId>com.microsoft.windowsazure</groupId>
+ <artifactId>microsoft-windowsazure-api</artifactId>
+ <version>0.1.0</version>
+ </dependency>
+
+##Minimum Requirements
+
+* Java 1.6
+* (Optional) Maven
+
+
+##Usage
+
+To use this SDK to call Windows Azure services, you need to first create an
account. To host your Java code in Windows Azure, you additionally need to download
the full Windows Azure SDK for Java - which includes packaging, emulation, and
-deployment tools.</p>
+deployment tools.
+
+##Code Samples
-<h2>Code Samples</h2>
-<p>The following is a quick example on how to set up a Azure blob using the API
-and uploading a file to it. For additional information on using the client libraries to access Azure services see the How To guides listed <a href="http://www.windowsazure.com/en-us/develop/java/">
-here</a>.<br/>
+The following is a quick example on how to set up a Azure blob using the API
+and uploading a file to it. For additional information on using the client libraries to access Azure services see the How To guides listed [here](http://www.windowsazure.com/en-us/develop/java/).
-<pre>import com.microsoft.windowsazure.services.core.storage.*;
-import com.microsoft.windowsazure.services.blob.client.*;
+ import com.microsoft.windowsazure.services.core.storage.*;
+ import com.microsoft.windowsazure.services.blob.client.*;
-public class BlobSample {
+ public class BlobSample {
- public static final String storageConnectionString =
- "DefaultEndpointsProtocol=http;" +
- "AccountName=your_account_name;" +
- "AccountKey= your_account_name";
+ public static final String storageConnectionString =
+ "DefaultEndpointsProtocol=http;" +
+ "AccountName=your_account_name;" +
+ "AccountKey= your_account_name";
- public static void main(String[] args)
- {
- try
+ public static void main(String[] args)
{
- CloudStorageAccount account;
- CloudBlobClient serviceClient;
- CloudBlobContainer container;
- CloudBlockBlob blob;
+ try
+ {
+ CloudStorageAccount account;
+ CloudBlobClient serviceClient;
+ CloudBlobContainer container;
+ CloudBlockBlob blob;
- account = CloudStorageAccount.parse(storageConnectionString);
- serviceClient = account.createCloudBlobClient();
- // Container name must be lower case.
- container = serviceClient.getContainerReference("blobsample");
- container.createIfNotExist();
+ account = CloudStorageAccount.parse(storageConnectionString);
+ serviceClient = account.createCloudBlobClient();
+ // Container name must be lower case.
+ container = serviceClient.getContainerReference("blobsample");
+ container.createIfNotExist();
- // Set anonymous access on the container.
- BlobContainerPermissions containerPermissions;
- containerPermissions = new BlobContainerPermissions();
-
- // Upload an image file.
- blob = container.getBlockBlobReference("image1.jpg");
- File fileReference = new File ("c:\\myimages\\image1.jpg");
- blob.upload(new FileInputStream(fileReference), fileReference.length());
- }
- catch (FileNotFoundException fileNotFoundException)
- {
- System.out.print("FileNotFoundException encountered: ");
- System.out.println(fileNotFoundException.getMessage());
- System.exit(-1);
- }
- catch (StorageException storageException)
- {
- System.out.print("StorageException encountered: ");
- System.out.println(storageException.getMessage());
- System.exit(-1);
- }
- catch (Exception e)
- {
- System.out.print("Exception encountered: ");
- System.out.println(e.getMessage());
- System.exit(-1);
- }
+ // Set anonymous access on the container.
+ BlobContainerPermissions containerPermissions;
+ containerPermissions = new BlobContainerPermissions();
+
+ // Upload an image file.
+ blob = container.getBlockBlobReference("image1.jpg");
+ File fileReference = new File ("c:\\myimages\\image1.jpg");
+ blob.upload(new FileInputStream(fileReference), fileReference.length());
+ }
+ catch (FileNotFoundException fileNotFoundException)
+ {
+ System.out.print("FileNotFoundException encountered: ");
+ System.out.println(fileNotFoundException.getMessage());
+ System.exit(-1);
+ }
+ catch (StorageException storageException)
+ {
+ System.out.print("StorageException encountered: ");
+ System.out.println(storageException.getMessage());
+ System.exit(-1);
+ }
+ catch (Exception e)
+ {
+ System.out.print("Exception encountered: ");
+ System.out.println(e.getMessage());
+ System.exit(-1);
+ }
+ }
}
-}
-</pre></p>
-
-<h1>Need Help?</h1>
-<p>Be sure to check out the Windows Azure <a href="http://go.microsoft.com/fwlink/?LinkId=234489">
-Developer Forums on Stack Overflow</a> if you have trouble with the provided code.</p>
-
-<h1>Contribute Code or Provide Feedback</h1>
-<p>If you would like to become an active contributor to this project please follow the instructions provided in <a href="http://windowsazure.github.com/guidelines.html">Windows Azure Projects Contribution Guidelines</a>.</p>
-<p>If you encounter any bugs with the library please file an issue in the <a href="https://github.com/WindowsAzure/azure-sdk-for-java/issues">Issues</a> section of the project.</p>
-
-<h1>Learn More</h1>
-<ul>
- <li><a href="http://www.windowsazure.com/en-us/develop/java/">Windows Azure Java
- Developer Center</a></li>
- <li><a href="http://dl.windowsazure.com/javadoc/">
- JavaDocs</a></li>
-</ul>
+
+#Need Help?
+
+Be sure to check out the Windows Azure [Developer Forums on Stack Overflow](http://go.microsoft.com/fwlink/?LinkId=234489) if you have trouble with the provided code.
+
+#Contribute Code or Provide Feedback
+
+If you would like to become an active contributor to this project please follow the instructions provided in [Windows Azure Projects Contribution Guidelines](http://windowsazure.github.com/guidelines.html).
+
+If you encounter any bugs with the library please file an issue in the [Issues](https://github.com/WindowsAzure/azure-sdk-for-java/issues) section of the project.
+
+#Learn More
+
+* [Windows Azure Java Developer Center](http://www.windowsazure.com/en-us/develop/java/)
+* [JavaDocs](http://dl.windowsazure.com/javadoc/)
Something went wrong with that request. Please try again.