From a643d69d235c2401be6b63f0c75a8277ded7430a Mon Sep 17 00:00:00 2001 From: Matt Farina Date: Mon, 21 Apr 2014 14:16:49 -0400 Subject: [PATCH] Initial addition of the top level README. Partially implements blueprint initial-docs Change-Id: I205ec57744249de14cfd963c6ed436354b32019e --- README.rst | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..9b33e2c --- /dev/null +++ b/README.rst @@ -0,0 +1,42 @@ +OpenStack SDK for .NET +====================== + +The OpenStack SDK for .NET is an SDK, written for the Microsoft .NET platform, providing developers with what they need to write software against `OpenStack `_, the open source cloud platform. + +Quick Start Example +------------------- +The following code will connect to Openstack, and print out all of the containers in the default storage account:: + + using System; + using System.Linq; + using System.Security; + using System.Threading; + using Openstack; + using Openstack.Identity; + using Openstack.Storage; + + var authUri = new Uri("https://region.identity.host.com:12345/v2.0/tokens"); + var userName = "user name"; + var password = "password"; + var tenantId = "XXXXXXXXXXXXXX-Project"; + + var securePassword = new SecureString(); + password.ToCharArray().ToList().ForEach(securePassword.AppendChar); + + var credential = new OpenstackCredential(authUri, userName, securePassword, tenantId); + var client = new OpenstackClient(credential, CancellationToken.None); + + await client.Connect(); + + var storageServiceClient = client.CreateServiceClient(); + var storageAccount = await storageServiceClient.GetStorageAccount(); + foreach(var container in storageAccount.Containers) + { + Console.WriteLine(container.Name); + } + +For more examples see the *OpenStack/Examples* directory. + +Development +----------- +The `homepage for the development effort `_ is on the OpenStack Wiki. The .NET SDK is developed through the same processes as the OpenStack services. `Features requests `_ and `bugs `_ are filed through launchpad. \ No newline at end of file