Skip to content

Commit b8b0b50

Browse files
committed
readme
1 parent 8f3d85a commit b8b0b50

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,21 @@
66

77
## Introduction
88

9-
**XML.jl** offers both *lazy* and *eager* data structures for reading and writing XML files with a consistent interface:
10-
11-
- For `XML.RawData`, `XML.RowNode`, and `XML.Node`:
12-
- `nodetype(node) --> XML.NodeType` (See `?XML.NodeType` for details).
13-
- `tag(node) --> String or Nothing`
14-
- `attributes(node) --> OrderedDict{String,String} or Nothing`
15-
- `value(node) --> String or Nothing`
16-
- `children(node) --> Vector{typeof(node)}`
17-
- `depth(node) --> Int`
18-
- For `XML.RawData` and `XML.RowNode` only:
19-
- `next(node) --> typeof(node)`
20-
- `prev(node) --> typeof(node)`
21-
- `parent(node) --> typeof(node)`
9+
This package offers fast data structures for reading and writing XML files with a consistent interface:
10+
11+
#### Interface Core:
12+
13+
- `nodetype(node) --> XML.NodeType` (See `?XML.NodeType` for details).
14+
- `tag(node) --> String or Nothing`
15+
- `attributes(node) --> OrderedDict{String,String} or Nothing`
16+
- `value(node) --> String or Nothing`
17+
- `children(node) --> Vector{typeof(node)}`
18+
- `depth(node) --> Int`
19+
20+
#### Interface for Lazy Data Structures:
21+
- `next(node) --> typeof(node)`
22+
- `prev(node) --> typeof(node)`
23+
- `parent(node) --> typeof(node)`
2224

2325
## Quickstart
2426

0 commit comments

Comments
 (0)