From 664df896e0a6757c65defb1acf78a99aabc1f318 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 7 Apr 2017 12:23:18 +0200 Subject: [PATCH] README: Rearrange the methods a bit Signed-off-by: Gergely Nagy --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 63d333ca..00be48d8 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,19 @@ void setup () { 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()` > 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()`. -### `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()` > Returns the CRC checksum of the layout. Should only be used after calling