README.rdoc in to_pass-0.8.0 vs README.rdoc in to_pass-0.9.0
- old
+ new
@@ -17,11 +17,11 @@
$ gem install to_pass
If you want to install from source, you can download a tarball or zipfile from
github.
- $ curl -L http://github.com/kronn/to_pass/tarball/v0.7.0 -o to_pass.tar.gz
+ $ curl -L https://github.com/kronn/to_pass/tarball/v0.9.0 -o to_pass.tar.gz
$ tar -xzf to_pass.tar.gz
$ cd kronn-to_pass-HASHVALUE
$ ./setup.rb install
The tarball contains a directory which has a part of the commit hash in its
@@ -48,10 +48,12 @@
A more direct approach is the facade provided by ToPass::Base
irb> require 'to_pass'
irb> ToPass::Base.new('test', :basic_de).to_s
# => 't35t'
+ irb> ToPass::Base.new('test', :basic_de).password
+ # => 't35t'
=== CLI
$ to_pass "test" # => t35t
$ to_pass "there is one problem for us, too" -a basic_en # => ti1p4u2
@@ -60,10 +62,31 @@
This example is a bit Mac OSX-centric, but you should get the point.
$ echo "test" | to_pass | pbcopy
+=== Customizing
+
+In order to fully utilize to_pass, you need to make your own algorithm.
+
+You can get a list of existing algorithms through the CLI:
+
+ $ to_pass --algorithms # or: to_pass -A
+
+Likewise, you can get a list of existing converters:
+
+ $ to_pass --converters # or: to_pass -C
+
+=== Configuration
+
+You can customize the default behaviour by adding a configuration file like this
+
+ $ mkdir ~/.to_pass
+ $ echo 'algorithm: basic_de' >> ~/.to_pass/config
+ $ echo 'pipe_out: false' >> ~/.to_pass/config
+ $ echo 'pipe_in: false' >> ~/.to_pass/config
+
== Development
If you want to develop it further, patch something or are just plain curious:
you're welcome. This should get you started:
@@ -108,6 +131,6 @@
And of course, there is a README, but I think you have found it already...
== Copyright
-Copyright (c) 2009-2010 Matthias Viehweger. See doc/LICENSE for details.
+Copyright (c) 2009-2011 Matthias Viehweger. See doc/LICENSE for details.