Skip to content

Commit 301430d

Browse files
add rough function signatures to the README
1 parent c57d0d6 commit 301430d

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
@@ -34,11 +34,13 @@ However, since the rolling counter used is 32-bit, a 32-bit processor like [Arm
3434
See [the test](./test/main.c) for an example.
3535

3636
There are only 3 simple APIs.
37-
* joanne_coder__init
38-
* joanne_coder__push_command
39-
* joanne_coder__sync
37+
* joanne_coder__init(&config, &state, &tracking_state);
38+
* joanne_coder__push_command(&config, &state, slot, access_code, command);
39+
* joanne_coder__sync(&config, &state, slot, access_code);
4040

41-
Most of the detail can be obtained from [the test](./test/main.c).
41+
Autoinit mode is possible; simply supply `NULL` pointer as a `tracking_state` to the init function.
42+
43+
Most of other usage details can be obtained from [the test](./test/main.c).
4244

4345
## Prerequisites
4446

0 commit comments

Comments
 (0)