Merge branch 'master' of https://github.com/SV-Zanshin/MB85_FRAM

README.md

@@ -1,3 +1,35 @@
-# Unfinished/Work in progress MB85_FRAM
+# Fujitsu MB85nnn Family of FRAM memories
+<img src="https://github.com/SV-Zanshin/MB85_FRAM/blob/master/Images/MB85Breakout.jpg" width="175" align="right"/> *Arduino* library which defines methods for accessing most of the Fujitsu MB85nnn family FRAM memories. The library allows efficient reading from and writing to [Fujitsu FRAM](http://www.fujitsu.com/global/products/devices/semiconductor/memory/fram/overview/features/index.html) memories using I2C and allowing use of objects such as arrays or structures in addition to writing single bytes at a time. The FRAM memory has several advantages over conventional SRAM in that it allows at least 10 trillion read/write cycles which means that the programmer doesn't have to worry about heavy use of FRAM for changing data. The FRAM is 5V tolerant and there is an [Adafruit breakout](https://www.adafruit.com/product/1895) available.
+Up to 8 devices can be put on an I2C and the library allows several memories to be treated as one large contiguous memory. The following memories are supported:
+
+<table>
+  <tr>
+    <td><b>Memory Type</b></td>
+    <td><b>Storage Bits</b></td>
+    <td><b>Datasheets</b></td>
+  </tr>
+  <tr>
+    <td>MB85RC512T</td>
+    <td>512 kbit / 64KB</td>
+    <td><a href="http://www.fujitsu.com/global/documents/products/devices/semiconductor/fram/lineup/MB85RC512T-DS501-00028-4v0-E.pdf">MB85RC512T Datasheet</a></td>
+  </tr>
+  <tr>
+    <td>MB85RC256V</td>
+    <td>256 kbit / 32KB</td>
+    <td><a href="http://www.fujitsu.com/global/documents/products/devices/semiconductor/fram/lineup/MB85RC256V-DS501-00017-5v1-E.pdf">MB85RC256V Datasheet</a></td>
+  </tr>
+  <tr>
+    <td>MB85RC128A</td>
+    <td>128 kbit / 16KB</td>
+    <td><a href="http://www.fujitsu.com/global/documents/products/devices/semiconductor/fram/lineup/MB85RC128A-DS501-00018-4v0-E.pdf>MB85RC128A Datasheet</a></td>
+  </tr>
+  <tr>
+    <td>MB85RC64TA<br>MB85RC64A<br>MB85RC64V</td>
+    <td>64 kbit / 8KB</td>
+    <td><a http://www.fujitsu.com/global/documents/products/devices/semiconductor/fram/lineup/MB85RC64TA-DS501-00044-2v0-E.pdf">MB85RC64TA Datasheet</a><br><a href="http://www.fujitsu.com/global/documents/products/devices/semiconductor/fram/lineup/MB85RC64A-DS501-00019-4v0-E.pdf">MB85RC64A Datasheet</a><br><a href="http://www.fujitsu.com/global/documents/products/devices/semiconductor/fram/lineup/MB85RC64V-DS501-00013-7v0-E.pdf">MB85RC64V Datasheet</a></td>
+  </tr>
+</table>
+
+See the [Wiki pages](https://github.com/SV-Zanshin/MB85_FRAM/wiki) for details of the class and the variables / functions accessible in it.
 
 ![Zanshin Logo](https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif) <img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" width="75"/>