Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated README

  • Loading branch information...
commit e0f8aba2ffa33fd858ed71ea00b57925d55b1c3e 1 parent c940785
@christianz authored
Showing with 10 additions and 7 deletions.
  1. +8 −7 README.md
  2. +2 −0  beanstalkapp-net.csproj
View
15 README.md
@@ -1,32 +1,33 @@
-= beanstalkapp-net
+beanstalkapp-net
+=====
Beanstalk RESTful API wrapper written in C#. Follows the conventions outlined in the [Official Ruby gem](https://github.com/isabanin/beanstalkapp)
[See the official API for more information](http://api.beanstalkapp.com)
-== Installation
+## Installation
For now, grab the source code and compile it yourself (it's very quick).
-== License
+## License
See MIT-LICENSE.
-== Dependencies
+## Dependencies
Uses and includes the [Json.NET](http://json.codeplex.com/) library.
-== Usage
+## Usage
First enable API access in your Beanstalk account by going to Account > Setup. Only the account owner can do that.
Reference beanstalkapp_net.dll in your project and initialize the wrapper like this:
- Beanstalk.Initialize("username", "password", "your_beanstalk_subdomain");
+ Beanstalk.Initialize("username", "password", "your_beanstalk_subdomain");
Then you can start using the API:
- var accounts = Account.FindAll();
+ var accounts = Account.FindAll();
For information about all API methods please go to the official documentation site:
View
2  beanstalkapp-net.csproj
@@ -63,6 +63,7 @@
<Compile Include="FeedKey.cs" />
<Compile Include="Integration.cs" />
<Compile Include="Invitation.cs" />
+ <None Include="MIT-LICENSE" />
<Compile Include="Permission.cs" />
<Compile Include="Plan.cs" />
<Compile Include="Properties\AssemblyInfo.cs" />
@@ -77,6 +78,7 @@
</ItemGroup>
<ItemGroup>
<None Include="packages.config" />
+ <None Include="README.md" />
</ItemGroup>
<ItemGroup />
<ItemGroup>
Please sign in to comment.
Something went wrong with that request. Please try again.