Skip to content

Commit a18c69c

Browse files
authored
Update README.md
1 parent 049df5b commit a18c69c

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,7 @@ This is a arduino library that helps to buffer values.
1111

1212
## Getting Started
1313

14-
- ``` length``` Buffer size
15-
- ``` init ``` Initial value
16-
17-
### Constructors
14+
### Create buffer instance
1815
```
1916
Buffer b = Buffer(length, init);
2017
@@ -27,6 +24,11 @@ or
2724
Buffer* b = new Buffer(length, init);
2825
```
2926

27+
### Constructor
28+
```Buffer(length, init)``` Create a new instance and clear the buffer.
29+
``` length```: Buffer size, ``` init ```: Initial value
30+
31+
3032
### Getters
3133
- ```calcAverage()``` Calc the buffer average and return the result
3234
- ```getAverage()``` Just return the buffer average

0 commit comments

Comments
 (0)