Update README.md

ElectricImpSampleCode · web-flow · commit 4378cb48a311 · 2017-08-21T11:17:08.000+10:00
diff --git a/README.md b/README.md
@@ -73,7 +73,7 @@
 
 The SPIFlashFileSystem (SFFS) library implements a basic [wear leveling](https://en.wikipedia.org/wiki/Wear_leveling) file system intended for use with SPI Flash devices, using either the built-in [hardware.spiflash](https://electricimp.com/docs/api/hardware/spiflash) object on imp003 and above, or an external SPI Flash plus the [SPIFlash library](https://github.com/electricimp/spiflash) on the imp001 and imp002.
 
-**To add this library to your project, add `#require "SPIFlashFileSystem.device.lib.nut:2.0.0"` to the top of your device code.**
+**To add this library to your project, add** `#require "SPIFlashFileSystem.device.lib.nut:2.0.0"` **to the top of your device code.**
 
 ## Overview of the File System
 
@@ -151,7 +151,7 @@ Because each sector contains a FileID and SpanID, the sectors can be anywhere in
 
 When the SFFS deletes a file, it simply marks all of the pages the file was using as erased. In order to use those pages again in the future, we first need erase the sectors that the file used. This is done automatically through a process called garbage collection.
 
-Each time a file is closed, or erased the SFFS determins whether or not it needs to run the garbage collector. It does this by comparing the number of free pages to the *autoGcThreshold*, which can be set with [setAutoGc](#setautogcnumpages) method.
+Each time a file is closed or erased, the SFFS determines whether or not it needs to run the garbage collector. It does this by comparing the number of free pages to the *autoGcThreshold*, which can be set with the [*setAutoGc()*](#setautogcnumpages) method.
 
 ## Library Classes
 
@@ -216,7 +216,7 @@ If the *init()* method is called while the filesystem has files open, a `SPIFlas
 
 ### getFileList(*[orderByDate]*)
 
-The *getFileList()* returns an array of file information identical to that passed into the *init()* callback. It takes an optional parameter: orderByData, a Boolean value that specifies whether the returned files should be sorted into date order for you. The default value is `false`.
+The *getFileList()* returns an array of file information identical to that passed into the *init()* callback. It takes an optional parameter: *orderByDate*, which is a Boolean value that specifies whether the returned files should be sorted into date order for you. The default value is `false`.
 
 ```squirrel
 local files = sffs.getFileList();
@@ -256,12 +256,12 @@ server.log(filename + " is " + sffs.fileSize(filename) + " bytes long");
 
 This method returns information about the filesystem in the form of a table with the following keys:
 
-| Key        | Description |
-| ----------- | --------------- |
-| *size*     | The filesystem size in bytes |
-| *len*      | The number of files in the filesystem |
-| *start*    | The address of the first byte of SPI flash assigned to the filesystem |
-| *end*     | The address of the last byte of SPI flash assigned to the filesystem |
+| Key | Description |
+| --- | --- |
+| *size* | The filesystem size in bytes |
+| *len* | The number of files in the filesystem |
+| *start* | The address of the first byte of SPI flash assigned to the filesystem |
+| *end* | The address of the last byte of SPI flash assigned to the filesystem |
 | *pages* | The number of pages available in the filesystem |
 
 ```squirrel
@@ -270,26 +270,25 @@ local d = sffs.dimensions();
 
 ### created(*fileRef*)
 
-Gets the creation timestamp for a specified file reference (id or file name).
+Gets the creation timestamp for a specified file reference (ID or file name).
 
 ```squirrel
-// get creation date by file name
+// Get creation date by file name
 sffs.created("file.txt");
 
-// get creation date by id
+// Get creation date by ID
 sffs.created(5);
 ```
 
 ### getFreeSpace()
 
 This method returns an estimate of the free space available in the filesystem. Smaller files have more overhead than larger files so it is impossible to know exactly how much space is free. The information is returned as a table with two keys:
 
-| Key           | Description |
-| ------------- | --------------- |
-| *free*        | The estimated free space in bytes |
+| Key | Description |
+| --- | --- |
+| *free* | The estimated free space in bytes |
 | *freeable* | The estimated space in bytes that may be freed through further garbage collection |
 
-
 ### isFileOpen(*filename*)
 
 Returns `true` or `false` according to whether or not the specified file is currently open.
@@ -352,7 +351,7 @@ This method erases all files within the filesystem. It will return with an error
 
 ### setAutoGc(*numPages*)
 
-The *setAutoGc()* method sets the *autoGcThresgold* property.  The default *autoGcThresgold* property is 4. The garbage collector will automatically run when the filesystem has fewer than *autoGcThreshold* pages.
+The *setAutoGc()* method sets the *autoGcThresgold* property. The garbage collector will automatically run when the filesystem has fewer than *autoGcThreshold* pages. The default *autoGcThresgold* value is 4.
 
 Setting *numPages* to 0 will turn off automatic garbage collection.
 
@@ -366,16 +365,15 @@ sffs.setAutoGc(10);
 
 The *gc()* method manually starts the garbage collection process. The SPIFlashFileSystem is designed in such a way that the auto garbage collection *should* be sufficient, and you should never need to manually call the *gc()* method.
 
-If the *numPages* parameter is specified, the garbage collector will free up to *numPages* pages and return when it completes (this is what happens when the garbage collector runs because the file system needs a page and none are free). If the *numPages* parameter is ommited, the garbage collector will run asynchronously in the background (this is what happens when the garbage collector runs because free pages drops below the value of *autoGcThreshold*).
-
+If the *numPages* parameter is specified, the garbage collector will free up to *numPages* pages and return when it completes (this is what happens when the garbage collector runs because the file system needs a page and none are free). If the *numPages* parameter is omited, the garbage collector will run asynchronously in the background (this is what happens when the garbage collector runs because free pages drops below the value of *autoGcThreshold*).
 
 ## SPIFlashFileSystem.File
 
-A *SPIFlashFileSystem.File* object is returned from the SPIFlashFileSystem each time a file is opened. The *SPIFlashFileSystem.File* object acts as a stream, with an internal pointer which can be manipulated with a variety of methods in the *SPIFlashFileSystem.File* class.  Typically, you will not need to instantiate SPIFlashFileSystem.File objects yourself.
+A *SPIFlashFileSystem.File* object is returned from the SPIFlashFileSystem each time a file is opened. The *SPIFlashFileSystem.File* object acts as a stream, with an internal pointer which can be manipulated with a variety of methods in the *SPIFlashFileSystem.File* class. Typically, you will not need to instantiate *SPIFlashFileSystem.File* objects yourself.
 
-## Constructor:  SPIFlashFileSystem.File(*filesystem, fileId, fileIndex, filename, mode*)
+### Constructor: SPIFlashFileSystem.File(*filesystem, fileId, fileIndex, filename, mode*)
 
-The constructor creates a file record. It takes the current SPIFlashFileSystem instance, the file’s unique integer ID, the index of the file in the internal record of open files, the current file’s filename, and its access mode: read or write, represented as the strings `"r"` and `"w"`, respectively.
+The constructor creates a file record. It takes the current *SPIFlashFileSystem* instance, the file’s unique integer ID, the index of the file in the internal record of open files, the current file’s filename, and its access mode: read or write, represented as the strings `"r"` and `"w"`, respectively.
 
 ## SPIFlashFileSystem.File Methods
 
@@ -434,7 +432,7 @@ server.log(file.read().tostring());
 
 Writes a string or blob to the end of a file's data opened with mode `"w"`. If you attempt to write to a file opened with mode `"r"` a `SPIFlashFileSystem.ERR_WRITE_R_FILE` error will be thrown.
 
-**Note:** The page header is not written to the SPI Flash until the entire page is written, or the [close](#close) method is called.
+**Note** The page header is not written to the SPI Flash until the entire page is written, or the [close](#close) method is called.
 
 In the following example, we download a file in chunks from the agent:
 
@@ -459,7 +457,6 @@ The *close()* method closes a file, and writes data to the SPI Flash if required
 
 *See [write()](#writedata) for sample usage.*
 
-
 ## SPIFlashFileSystem.FAT
 
 A SPIFlashFileSystem.FAT object is automatically generated when the filesystem is initialized. It records the file allocation table (FAT).
@@ -474,15 +471,15 @@ The constructor takes a master *SPIFlashFileSystem* object and, optionally, the
 
 This method scans the filesystem for files and uses them to construct the file allocation table.
 
-### get(*fileReference*)
+### get(*fileRef*)
 
-This method retrieves information about a specific file from the file allocation table. The value passed into *fileReference* can be either a file’s name (a string) or its ID (an integer). The method returns a table of information containing the following keys:
+This method retrieves information about a specific file from the file allocation table. The value passed into *fileRef* can be either a file’s name (a string) or its ID (an integer). The method returns a table of information containing the following keys:
 
 | Key | Description |
-| ----- | --------------- |
+| --- | --- |
 | *id* | The file’s ID (integer) |
 | *fname* | The file’s filename |
-| *spans* | ??? |
+| *spans* | The spans of the file |
 | *pages* | An array of pages in which the file is stored |
 | *pageCount* | The number of pages in which the file is stored |
 | *sizes* | An array of the size (in bytes) of the file chunks each page contains |
@@ -491,81 +488,92 @@ This method retrieves information about a specific file from the file allocation
 
 ### getFileList(*[orderByDate]*)
 
-The *getFileList()* returns an array of file information, one entry per file in the FAT. It takes an optional parameter: *orderByData*, a Boolean value that specifies whether the returned files should be sorted into date order for you. The default value is `false`. The information for each file is a table with the following keys:
+The *getFileList()* returns an array of file information, one entry per file in the FAT. It takes an optional parameter: *orderByDate*, a Boolean value that specifies whether the returned files should be sorted into date order for you. The default value is `false`. The information for each file is a table with the following keys:
 
 | Key | Description |
-| ----- | --------------- |
+| --- | --- |
 | *id* | The file’s ID (integer) |
 | *fname* | The file’s filename |
 | *size* |  The total size of the file |
 | *created* | A timestamp indicating the date and time of the file’s creation |
 
 ### getFileId(*filename*)
+
 This method takes a given file’s name and returns the unique integer by which it is referenced in the file allocation table.
 
-### fileExists(*fileReference*)
-This method returns `true` or `false` according to whether or not the specified file exists in the file allocation table. The value passed into fileReference can be either a file’s name (a string) or its ID (an integer).
+### fileExists(*fileRef*)
+
+This method returns `true` or `false` according to whether or not the specified file exists in the file allocation table. The value passed into *fileRef* can be either a file’s name (a string) or its ID (an integer).
 
 ### getFreePage()
-This method returns the address of a random free page in the filesystem. It will return an error, *SPIFlashFileSystem.ERR_NO_FREE_SPACE*, if it is unable to do so because there is no free space left.
+
+This method returns the address of a random free page in the filesystem. It will return an error, `SPIFlashFileSystem.ERR_NO_FREE_SPACE`, if it is unable to do so because there is no free space left.
 
 ### markPage(*address, status*)
-This method sets the status of the page at address. Status values can be any of the constants: *SPIFLASHFILESYSTEM_STATUS_FREE, SPIFLASHFILESYSTEM_STATUS_USED*, *SPIFLASHFILESYSTEM_STATUS_ERASED or SPIFLASHFILESYSTEM_STATUS_BAD*.
+
+This method sets the status of the page at address. Status values can be any of the constants: *SPIFLASHFILESYSTEM_STATUS_FREE*, *SPIFLASHFILESYSTEM_STATUS_USED*, *SPIFLASHFILESYSTEM_STATUS_ERASED* or *SPIFLASHFILESYSTEM_STATUS_BAD*.
 
 ### addPage(*fileId, page*)
+
 This method adds the specified page to the file allocation table for the specified file.
 
-### getPageCount(*fileReference*)
-This method returns the number of pages the files specified by the parameter fileReference comprises. The value passed into fileReference can be either a file’s name (a string) or its ID (an integer).
+### getPageCount(*fileRef*)
+
+This method returns the number of pages the files specified by the parameter fileReference comprises. The value passed into *fileRef* can be either a file’s name (a string) or its ID (an integer).
 
-### forEachPage(*fileReference, callback*)
-This method iterates over each page used to record the file specified by the parameter fileReference. For each page, the function passed into the parameter callback is called. This function takes a single parameter: the page it is passed.
+### forEachPage(*fileRef, callback*)
+
+This method iterates over each page used to record the file specified by the parameter *fileRef*. For each page, the function passed into the parameter callback is called. This function takes a single parameter: the page it is passed.
 
 ### pagesOrderedBySpan(*pages*)
+
 This method returns an array of pages ordered by the span.
 
 ### addSizeToLastSpan(*fileId, bytes*)
+
 This method updates the size of the last span in a file.
 
 ### set(*fileId, file*)
+
 This method sets the span for the file specified by its ID.
 
 ### removeFile(*filename*)
+
 This method removes the named file from the file allocation table.
 
 ### getSectorMap()
+
 This method returns the file allocation table’s sector map.
 
 ### getStats()
-This method returns a table of page usage information, specifically the number of pages in the filesystem in each of the four status categories. This information is returned as a table with the keys *free, used, erased and bad*. Each key’s value is an integer: the number of pages in the filesystem with that status.
+
+This method returns a table of page usage information, specifically the number of pages in the filesystem in each of the four status categories. This information is returned as a table with the keys *free*, *used*, *erased* and *bad*. Each key’s value is an integer: the number of pages in the filesystem with that status.
 
 ### describe()
-This method is intended to assist with debugging: it provides a readout of the current number of files in the file allocation table, and lists each file by name, the number of pages it spans and its total size.
 
+This method is intended to assist with debugging: it provides a readout of the current number of files in the file allocation table, and lists each file by name, the number of pages it spans and its total size.
 
 ## Testing
 
-Repository contains [impUnit](https://github.com/electricimp/impUnit) tests and a configuration for [impTest](https://github.com/electricimp/impTest).
+The repository contains [impUnit](https://github.com/electricimp/impUnit) tests and a configuration for [impTest](https://github.com/electricimp/impTest).
 
-Tests can be launched with:
+The tests can be launched with:
 
 ```bash
 imptest test
 ```
 
-By default configuration for the testing is read from [.imptest](https://github.com/electricimp/impTest/blob/develop/docs/imptest-spec.md).
-
-To run test with your settings (for example while you are developing), create your copy of **.imptest** file and name it something like **.imptest.local**, then run tests with:
+By default, the configuration for the testing is read from the file [*.imptest*](https://github.com/electricimp/impTest/blob/develop/docs/imptest-spec.md). To run tests with your settings (for example while you are developing), create a copy of the *.imptest* file and rename it (for example, *.imptest.local*), then run the tests with:
 
  ```bash
  imptest test -c .imptest.local
  ```
 
 ### Hardware
 
-Tests require an [Amy](https://electricimp.com/docs/hardware/resources/reference-designs/amy/) board or [imp003 Evaluation Board](https://electricimp.com/docs/hardware/imp003evb/). Any other boards with imp003 and above containing SPI flash with available user space may work too.
+The provided tests require an [imp003 Breakout Board](https://electricimp.com/docs/hardware/resources/reference-designs/imp003breakout/) or [imp003 Evaluation Board](https://electricimp.com/docs/hardware/imp003evb/). Any other boards with imp003 and above containing SPI flash with available user space may work too.
 
-imp001/002 support is planned.
+imp001 support is planned.
 
 ## To Do
 
