Skip to content

Commit

Permalink
Updates to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tapmodo committed Nov 5, 2015
1 parent 347bc82 commit 90c941c
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,7 @@ I was surprised to learn that no LDIF parsing library existed for node.
So I wrote one, with [peg.js](http://pegjs.org). It aims to be RFC-compliant.
Now I'll never have to use that cursed perl script again!

## Installation

Install easily with **npm**!

npm install ldif

## LDIF Format
## Theory

RFC2849 defines a somewhat complex format that can specify
*either* a series of LDAP records, or a series of changes to
Expand All @@ -26,7 +20,7 @@ A simple hand-made parser could be written for the most common
and simple use-cases, but this library aims to parse (and write)
the entire range of LDIF possible.

## Design Goals
### Design Goals

* 100% RFC-compliance; should comprehend any valid LDIF file
* Parsed records stored internally intact
Expand All @@ -37,6 +31,12 @@ the entire range of LDIF possible.

## Usage

### Installation

Install easily with *npm*!

npm install ldif

### Parsing

##### Parsing strings
Expand All @@ -57,8 +57,8 @@ var ldif = require('ldif');
console.log(ldif.parseFile('./rfc/example1.ldif'));
```

Both of these return an object format for an entire LDIF file.
In this case, example1.ldif specifies the contents of two LDAP records.
Both of these return an object format for an entire LDIF file.
In this case, example1.ldif specifies contents of two LDAP records.

##### Shifting records from parsed file
```javascript
Expand Down Expand Up @@ -129,7 +129,7 @@ console.log(file.toLDIF());
console.log(file.shift().toLDIF());
```

## Note on changes schema
### Note on changes schema

* For now, managing changes schema records are up to you
* `toLDIF()` output is apparently identical, that should be enough
Expand Down

0 comments on commit 90c941c

Please sign in to comment.