Skip to content

Commit 92d0a6f

Browse files
authored
Improve documentation
The README now makes it clear that what was referred to as *Parser* is in fact the BitSet constructor.
1 parent dc2efd0 commit 92d0a6f

File tree

1 file changed

+15
-19
lines changed

1 file changed

+15
-19
lines changed

README.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -90,26 +90,22 @@ function(BitSet) {
9090
</script>
9191
```
9292

93-
Parser
93+
Constructor
9494
===
95-
The parser accepts the following types of values in either function
96-
97-
Strings
98-
- Binary strings "010101"
99-
- Binary strings with prefix "0b100101"
100-
- Hexadecimal strings with prefix "0xaffe"
101-
102-
**Arrays**
103-
- The values of the array are the indizes to be set to 1
104-
105-
**Uint8Array**
106-
- A binary representation in 8 bit form
107-
108-
**Number**
109-
- A binary value
110-
111-
**BitSet**
112-
- A BitSet object, which get copied over
95+
The default `BitSet` constructor accepts a single value of one the following types :
96+
97+
- String
98+
- Binary strings : `new BitSet("010101")`
99+
- Binary strings with prefix : `new BitSet("0b010101")`
100+
- Hexadecimal strings with prefix `new BitSet("0xaffe")`
101+
- Array
102+
- The values of the array are the indices to be set to 1 : `new BitSet([1,12,9])`
103+
- [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
104+
- A binary representation in 8 bit form
105+
- Number
106+
- A binary value
107+
- BitSet
108+
- A BitSet object, which get copied over
113109

114110

115111
Functions

0 commit comments

Comments
 (0)