README.md in arachni-rpc-0.1.3 vs README.md in arachni-rpc-0.2.0
- old
+ new
@@ -1,10 +1,11 @@
# Arachni-RPC
+
<table>
<tr>
<th>Version</th>
- <td>0.1.2</td>
+ <td>0.2.0</td>
</tr>
<tr>
<th>Github page</th>
<td><a href="http://github.com/Arachni/arachni-rpc">http://github.com/Arachni/arachni-rpc</a></td>
<tr/>
@@ -12,76 +13,69 @@
<th>Code Documentation</th>
<td><a href="http://rubydoc.info/github/Arachni/arachni-rpc/">http://rubydoc.info/github/Arachni/arachni-rpc/</a></td>
</tr>
<tr>
<th>Author</th>
- <td><a href="mailto:tasos.laskos@gmail.com">Tasos "Zapotek" Laskos</a></td>
+ <td><a href="mailto:tasos.laskos@arachni-scanner.com">Tasos "Zapotek" Laskos</a></td>
</tr>
<tr>
<th>Twitter</th>
<td><a href="http://twitter.com/Zap0tek">@Zap0tek</a></td>
</tr>
<tr>
<th>Copyright</th>
- <td>2011-2012</td>
+ <td>2011-2014</td>
</tr>
<tr>
<th>License</th>
<td><a href="file.LICENSE.html">3-clause BSD</a></td>
</tr>
</table>
## Synopsis
-Arachni-RPC is a simple and lightweight Remote Procedure Call protocol which provides the basis for <a href="http://arachni.segfault.gr">Arachni</a>'s Grid infrastructure.
+Arachni-RPC is a simple and lightweight Remote Procedure Call protocol and implementation
+which provides the basis for <a href="http://arachni-scanner.com">Arachni</a>'s
+distributed infrastructure.
-This repository holds *only* the protocol specification although there currently are 2 (more like 1.5) available implementations:
+(Based on the [Arachni::Reactor](https://github.com/Arachni/arachni-reactor) framework.)
- - <a href="http://github.com/Arachni/arachni-rpc-em">Arachni-RPC EM</a> -- Uses EventMachine for network related operations and provides both a client and a server, this is the one used by Arachni.
- - <a href="http://github.com/Arachni/arachni-rpc-pure">Arachni-RPC Pure</a> -- Provides a synchronous client using pure Ruby OpenSSL sockets and has no 3rd party dependencies.
-
## Features
- - Extremely lightweight
- - Very simple design
- - Token-based authentication
+ - Extremely lightweight.
+ - Very simple design.
+ - TLS encryption.
+ - Configurable serializer.
+ - Can intercept RPC responses and translate them into native objects for
+ when using serializers that only support basic types, like JSON or MessagePack.
+ - Token-based authentication.
+ - Pure-Ruby.
+ - Multi-platform, tested on:
+ - Linux
+ - OSX
+ - Windows
## Installation
-I can't think of a lot of uses for manually installing the protocol specification
-(it'll most likely be installed as a dependency for some other project) but in case you want to some instructions follow.
+ gem install arachni-rpc
-### Gem
-
-```gem install arachni-rpc```
-
-### Source
-
-If you want to clone the repository and work with the source code:
-
- git co git://github.com/arachni/arachni-rpc.git
- cd arachni-rpc
- rake install
-
-
## Running the Specs
-In order to run the specs you must first install RSpec:
- gem install rspec
-
-Then:
-
+ bundle install
rake spec
## Protocol specifications
-You can find that information in the [Wiki](https://github.com/Arachni/arachni-rpc/wiki).
+You can find the RPC protocol specification at the
+[Wiki](https://github.com/Arachni/arachni-rpc/wiki).
## Bug reports/Feature requests
-Please send your feedback using Github's issue system at
+
+Please send your feedback using GitHub's issue system at
[http://github.com/arachni/arachni-rpc/issues](http://github.com/arachni/arachni-rpc/issues).
## License
-Arachni-RPC is provided under the 3-clause BSD license.<br/>
+
+Arachni-RPC is provided under the 3-clause BSD license.
See the [LICENSE](file.LICENSE.html) file for more information.