verdnatura-mirror
/
node-ldapjs
mirror of https://github.com/ldapjs/node-ldapjs.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Cleanup README formatting

This commit is contained in:
Patrick Mooney 2014-07-06 11:55:33 -05:00
parent 550e301083
commit ee83d0e3ee
1 changed files with 48 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,16 +1,17 @@
# Ldapjs # LDAPjs
[!['Build status'][travis_image_url]][travis_page_url] [!['Build status'][travis_image_url]][travis_page_url]
[travis_image_url]: https://api.travis-ci.org/mcavage/node-ldapjs.png [travis_image_url]: https://api.travis-ci.org/mcavage/node-ldapjs.svg
[travis_page_url]: https://travis-ci.org/mcavage/node-ldapjs [travis_page_url]: https://travis-ci.org/mcavage/node-ldapjs
ldapjs makes the LDAP protocol a first class citizen in Node.js. LDAPjs makes the LDAP protocol a first class citizen in Node.js.
## Usage ## Usage
For full docs, head on over to <http://ldapjs.org>. For full docs, head on over to <http://ldapjs.org>.
```javascript
var ldap = require('ldapjs'); var ldap = require('ldapjs');
var server = ldap.createServer(); var server = ldap.createServer();
@ -33,6 +34,7 @@ For full docs, head on over to <http://ldapjs.org>.
server.listen(1389, function() { server.listen(1389, function() {
console.log('ldapjs listening at ' + server.url); console.log('ldapjs listening at ' + server.url);
}); });
```
To run that, assuming you've got the [OpenLDAP](http://www.openldap.org/) client To run that, assuming you've got the [OpenLDAP](http://www.openldap.org/) client
on your system: on your system:
@ -45,6 +47,7 @@ on your system:
## Formatting objectGUID attribute value ## Formatting objectGUID attribute value
```javascript
var ldap = require('ldapjs'); var ldap = require('ldapjs');
ldap.Attribute.settings.guid_format = ldap.GUID_FORMAT_B; ldap.Attribute.settings.guid_format = ldap.GUID_FORMAT_B;
@ -67,6 +70,7 @@ on your system:
}); });
}); });
}); });
```
_Note: for the sake of simplicity all checks and error handling was removed from the sample above._ _Note: for the sake of simplicity all checks and error handling was removed from the sample above._
@ -94,7 +98,7 @@ Available formatting modes:
where the fourth value is a subset of eight hexadecimal values that is also enclosed in braces: where the fourth value is a subset of eight hexadecimal values that is also enclosed in braces:
{0x00000000,0x0000,0x0000,{0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00}} {0x00000000,0x0000,0x0000,{0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00}}
Guid formatting is unobtrusive by default. You should explicitly define formatting mode in order to enable it. GUID formatting is unobtrusive by default. You should explicitly define formatting mode in order to enable it.
## License ## License