README: Rearrange the methods a bit

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/365/head
Gergely Nagy 8 years ago
parent 957866fb84
commit 664df896e0

@ -62,6 +62,19 @@ void setup () {
The plugin provides the `EEPROMSettings` object, which has the following methods: The plugin provides the `EEPROMSettings` object, which has the following methods:
### `requestSlice(size)`
> Requests a slice of the `EEPROM`, and returns the starting address (or 0 on
> error, including when the request arrived after sealing the layout).
>
> Should only be called **before** calling `seal()`.
### `seal()`
> Seal the `EEPROM` layout, so no new slices can be requested. The CRC checksum
> is considered final at this time, and the `isValid()`, `crc()`, `used()` and
> `version()` methods can be used from this point onwards.
### `update()` ### `update()`
> Updates the `EEPROM` header with the current status quo, including the version > Updates the `EEPROM` header with the current status quo, including the version
@ -91,19 +104,6 @@ The plugin provides the `EEPROMSettings` object, which has the following methods
> >
> Should only be called after calling `seal()`. > Should only be called after calling `seal()`.
### `requestSlice(size)`
> Requests a slice of the `EEPROM`, and returns the starting address (or 0 on
> error, including when the request arrived after sealing the layout).
>
> Should only be called **before** calling `seal()`.
### `seal()`
> Seal the `EEPROM` layout, so no new slices can be requested. The CRC checksum
> is considered final at this time, and the `isValid()`, `crc()`, `used()` and
> `version()` methods can be used from this point onwards.
### `crc()` ### `crc()`
> Returns the CRC checksum of the layout. Should only be used after calling > Returns the CRC checksum of the layout. Should only be used after calling

Loading…
Cancel
Save