Commits

Anonymous committed 7eebe5a

README generated from main module, more interesting. Some Build.PL cleanup

  • Participants
  • Parent commits efeb921

Comments (0)

Files changed (3)

 
 my $builder = Module::Build->new(
     module_name         => 'Passwd::Keyring::KDEWallet',
+    license             => 'perl',
     dynamic_config      => 1,
-    license             => 'perl',
-    dist_author         => q{Marcin Kasperski <Marcin.Kasperski@mekk.waw.pl>},
-    dist_version_from   => 'lib/Passwd/Keyring/KDEWallet.pm',
+
     build_requires => {
         'Module::Build' => '0.19', # xs
         'ExtUtils::CBuilder' => 0,
         'perl' => 5.006,
         'Net::DBus' => 0,
     },
+
+    create_makefile_pl => 'traditional',
     add_to_cleanup      => [ 'Passwd-Keyring-KDEWallet-*' ],
-    create_makefile_pl => 'traditional',
+
+    create_readme       => 1,
+    dist_author         => q{Marcin Kasperski <Marcin.Kasperski@mekk.waw.pl>},
+    dist_version_from   => 'lib/Passwd/Keyring/KDEWallet.pm',
     meta_merge => {
         keywords => [ qw/ passwords security secure-storage keyring KDE KDEWallet / ],
         resources => {
+Passwd::Keyring::KDEWallet
+
+Passwd::Keyring is about using secure storage for passwords
+and other credentials used in perl scripts and applications.
+
+Passwd::Keyring::KDEWallet uses KDE KWallet API to securely
+preserve passwords and is available to people using KDE
+desktop environment (or at least with installed kwallet).
+
+INSTALLATION
+
+To install this module, run the following commands:
+
+	perl Build.PL
+	./Build
+	./Build test
+	./Build install
+
+SUPPORT AND DOCUMENTATION
+
+After installing, you can find documentation for this module with the
+perldoc command.
+
+    perldoc Passwd::Keyring::KDEWallet
+
+You can also look for information at:
+
+    http://bitbucket.org/Mekk/perl-keyring-kde_wallet
+
+
+LICENSE AND COPYRIGHT
+
+Copyright (C) 2012 Marcin Kasperski
+
+This program is free software; you can redistribute it and/or modify it
+under the terms of either: the GNU General Public License as published
+by the Free Software Foundation; or the Artistic License.
+
+See http://dev.perl.org/licenses/ for more information.
+
-Passwd::Keyring::KDEWallet
+NAME
+    Passwd::Keyring::KDEWallet - Password storage implementation based on
+    KDE Wallet.
 
-Passwd::Keyring is about using secure storage for passwords
-and other credentials used in perl scripts and applications.
+VERSION
+    Version 0.2001
 
-Passwd::Keyring::KDEWallet uses KDE KWallet API to securely
-preserve passwords and is available to people using KDE
-desktop environment (or at least with installed kwallet).
+SYNOPSIS
+    KDE Wallet based implementation of Passwd::Keyring.
 
-INSTALLATION
+        use Passwd::Keyring::KDEWallet;
 
-To install this module, run the following commands:
+        my $keyring = Passwd::Keyring::KDEWallet->new(app=>"My beautiful app", group=>"My app web passwords");
 
-	perl Build.PL
-	./Build
-	./Build test
-	./Build install
+        $keyring->set_password("John", "verysecret", "my-pseudodomain");
+        # And later, on next run maybe
+        my $password = $keyring->get_password("John", "my-pseudodomain");
+        # plus
+        $keyring->clear_password("John", "my-pseudodomain");
 
-SUPPORT AND DOCUMENTATION
+    Note: see Passwd::Keyring::Auto::KeyringAPI for detailed comments on
+    keyring method semantics (this document is installed with
+    Passwd::Keyring::Auto package).
 
-After installing, you can find documentation for this module with the
-perldoc command.
+SUBROUTINES/METHODS
+  new
+    Initializes the processing. Croaks if kwallet does not seem to be
+    available.
 
-    perldoc Passwd::Keyring::KDEWallet
+  set_password(username, password, domain)
+    Sets (stores) password identified by given domain for given user
 
-You can also look for information at:
+  get_password($user_name, $domain)
+    Reads previously stored password for given user in given app. If such
+    password can not be found, returns undef.
 
-    http://bitbucket.org/Mekk/perl-keyring-kde_wallet
+  clear_password($user_name, $domain)
+    Removes given password (if present)
 
+  is_persistent
+    Returns info, whether this keyring actually saves passwords
+    persistently.
+
+    (true in this case)
+
+AUTHOR
+    Marcin Kasperski
+
+    Approach inspired by http://www.perlmonks.org/?node_id=869620.
+
+BUGS
+    Please report any bugs or feature requests to issue tracker at
+    https://bitbucket.org/Mekk/perl-keyring-kdewallet.
+
+SUPPORT
+    You can find documentation for this module with the perldoc command.
+
+        perldoc Passwd::Keyring::KDEWallet
+
+    You can also look for information at:
+
+    http://search.cpan.org/~mekk/Passwd-Keyring-KDEWallet/
+
+    Source code is tracked at:
+
+    https://bitbucket.org/Mekk/perl-keyring-kdewallet
 
 LICENSE AND COPYRIGHT
+    Copyright 2010-2012 Marcin Kasperski.
 
-Copyright (C) 2012 Marcin Kasperski
+    This program is free software; you can redistribute it and/or modify it
+    under the terms of either: the GNU General Public License as published
+    by the Free Software Foundation; or the Artistic License.
 
-This program is free software; you can redistribute it and/or modify it
-under the terms of either: the GNU General Public License as published
-by the Free Software Foundation; or the Artistic License.
+    See http://dev.perl.org/licenses/ for more information.
 
-See http://dev.perl.org/licenses/ for more information.
-