README.md in netsoul-1.1.0 vs README.md in netsoul-1.2.0
- old
+ new
@@ -17,64 +17,71 @@
## Installation
### On your desktop
- gem install netsoul
+```ruby
+gem install netsoul
+```
### In your project
#### Gemfile
- gem 'netsoul', '~> 0.1'
+```ruby
+gem 'netsoul', '~> 1.2'
+```
#### project.rb
- require 'netsoul'
+```ruby
+require 'netsoul'
+```
## Use the client
After installing the gem **netsoul**, call the client as described bellow.
- ```bash
- netsoul-ruby -config netsoul-config.yml
- ```
+```bash
+netsoul-ruby -config netsoul-config.yml
+```
### Example of _netsoul-config.yml_ file
#### Standard (MD5) authentication
- ```yaml
- ---|
- :login: 'kakesa_c'
- :socks_password: 'my socks password'
- # :unix_password: 'unix password needed for kerberos authentication' # :auth_method must be set to :krb5
- # :auth_method: :std # :std, :krb5
- # :server_host: 'ns-server.epita.fr'
- # :server_port: 4242
- # :state: :none # :actif, :away, :connection, :idle, :lock, :server, :none
- # :location: 'Home'
- # :user_group: 'ETNA_2008'
- ```
+```yaml
+---|
+:login: 'kakesa_c'
+:socks_password: 'my socks password'
+# :unix_password: 'unix password needed for kerberos authentication' # :auth_method must be set to :krb5
+# :auth_method: :std # :std, :krb5
+# :server_host: 'ns-server.epita.fr'
+# :server_port: 4242
+# :state: :none # :actif, :away, :connection, :idle, :lock, :server, :none
+# :location: 'Home'
+# :user_group: 'ETNA_2008'
+```
#### Kerberos authentication
- ```yaml
- ---|
- :login: 'kakesa_c'
- :unix_password: 'unix password'
- :auth_method: :krb5 # :std, :krb5
- # :socks_password: 'my socks password'
- # :server_host: 'ns-server.epita.fr'
- # :server_port: 4242
- # :state: :none # :actif, :away, :connection, :idle, :lock, :server, :none
- # :location: 'Home'
- # :user_group: 'ETNA_2008'
- ```
+```yaml
+---|
+:login: 'kakesa_c'
+:unix_password: 'unix password'
+:auth_method: :krb5 # :std, :krb5
+# :socks_password: 'my socks password'
+# :server_host: 'ns-server.epita.fr'
+# :server_port: 4242
+# :state: :none # :actif, :away, :connection, :idle, :lock, :server, :none
+# :location: 'Home'
+# :user_group: 'ETNA_2008'
+```
## Use the library in custom Netsoul Ruby client
-__[TODO]__
+Look at the client implementation in this gem: [https://github.com/fenicks/netsoul-ruby/blob/master/bin/netsoul-ruby]().
+This client is implemented in less than 150 lines of code.
## Contributing
1. Fork it ( https://github.com/fenicks/netsoul-ruby/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)