Skip to content

Commit c1f6410

Browse files
Update README.rdoc
1 parent 05afd7c commit c1f6410

File tree

1 file changed

+3
-70
lines changed

1 file changed

+3
-70
lines changed

README.rdoc

Lines changed: 3 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,5 @@
1-
= Net::LDAP for Ruby {<img src="https://travis-ci.org/%3C/span%3Eruby-%3Cspan%20class="x x-first x-last">ldap/ruby-net-ldap.png" />}[https://travis-ci.org/ruby-ldap/ruby-net-ldap]
1+
**The latest version of ruby-net-ldap (as of 12th Sep, 2019), Forked to work with QuotaGuard Static**
22

3-
== Description
3+
To use, add `gem 'net-ldap', github: "matthewmaddern/ruby-net-ldap", branch: "master"` to your Gemfile.
44

5-
Net::LDAP for Ruby (also called net-ldap) implements client access for the
6-
Lightweight Directory Access Protocol (LDAP), an IETF standard protocol for
7-
accessing distributed directory services. Net::LDAP is written completely in
8-
Ruby with no external dependencies. It supports most LDAP client features and a
9-
subset of server features as well.
10-
11-
Net::LDAP has been tested against modern popular LDAP servers including
12-
OpenLDAP and Active Directory. The current release is mostly compliant with
13-
earlier versions of the IETF LDAP RFCs (2251–2256, 2829–2830, 3377, and 3771).
14-
Our roadmap for Net::LDAP 1.0 is to gain full <em>client</em> compliance with
15-
the most recent LDAP RFCs (4510–4519, plus portions of 4520–4532).
16-
17-
== Where
18-
19-
* {GitHub}[https://github.com/ruby-ldap/ruby-net-ldap]
20-
* {[email protected]}[http://groups.google.com/group/ruby-ldap]
21-
22-
== Synopsis
23-
24-
See Net::LDAP for documentation and usage samples.
25-
26-
== Requirements
27-
28-
Net::LDAP requires a Ruby 2.0.0 compatible interpreter or better.
29-
30-
== Install
31-
32-
Net::LDAP is a pure Ruby library. It does not require any external libraries.
33-
You can install the RubyGems version of Net::LDAP available from the usual
34-
sources.
35-
36-
gem install net-ldap
37-
38-
Simply require either 'net-ldap' or 'net/ldap'.
39-
40-
== Extensions
41-
42-
This library focuses on the core LDAP RFCs referenced in the description.
43-
However, we recognize there are commonly used extensions to the spec that are
44-
useful. If there is another library which handles it, we list it here.
45-
46-
* {resolv-srv}[https://rubygems.org/gems/resolv-srv]: Support RFC2782 SRV record lookup and failover
47-
48-
== Develop
49-
50-
This task will run the test suite and the
51-
{RuboCop}[https://github.com/bbatsov/rubocop] static code analyzer.
52-
53-
rake rubotest
54-
55-
CI takes too long? If your local box supports
56-
{Vagrant}[https://www.vagrantup.com/], you can run most of the tests
57-
in a VM on your local box. For more details and setup instructions, see
58-
{test/support/vm/openldap/README.md}[https://github.com/ruby-ldap/ruby-net-ldap/tree/master/test/support/vm/openldap/README.md]
59-
60-
== Release
61-
62-
This section is for gem maintainers to cut a new version of the gem.
63-
64-
* Check out a new branch `release-VERSION`
65-
* Update lib/net/ldap/version.rb to next version number X.X.X following {semver}(http://semver.org/).
66-
* Update `History.rdoc`. Get latest changes with `script/changelog`
67-
* Open a pull request with these changes for review
68-
* After merging, on the master branch, run `script/release`
69-
70-
:include: Contributors.rdoc
71-
72-
:include: License.rdoc
5+
For more informaiton, view the original version of net-ldap here: https://github.com/ruby-ldap/ruby-net-ldap

0 commit comments

Comments
 (0)