Generate the new README.md

This commit is contained in:
Kiara Navarro
2014-09-25 01:27:39 -05:00
parent 07300f4477
commit b5322316aa

View File

@@ -1,20 +1,41 @@
rfid rduino RFID Library for MFRC522
==== =======================================================
This library is use to read RFID Cards through MIFARE RC522 reader using SPI interface on Arduino Board.
Arduino RFID Library for MFRC522
Read a card using a mfrc522 reader on your SPI interface on your Arduino
* Pin layout should be as follows (on Arduino Uno): Pin Layout for Arduino UNO
------------
* MOSI: Pin 11 / ICSP-4 * MOSI: Pin 11 / ICSP-4
* MISO: Pin 12 / ICSP-1 * MISO: Pin 12 / ICSP-1
* SCK : Pin 13 / ISCP-3 * SCK : Pin 13 / ISCP-3
* SS : Pin 10 (Configurable) * SS : Pin 10 (Configurable)
* RST : Pin 9 (Configurable) * RST : Pin 9 (Configurable)
*
* Pin layout should be as follows (on Arduino Mega): Pin Layout for Arduino Mega
------------
* MOSI: Pin 51 / ICSP-4 * MOSI: Pin 51 / ICSP-4
* MISO: Pin 50 / ICSP-1 * MISO: Pin 50 / ICSP-1
* SCK : Pin 52 / ISCP-3 * SCK : Pin 52 / ISCP-3
* SS : Pin 53 (Configurable) * SS : Pin 53 (Configurable)
* RST : Pin 5 (Configurable) * RST : Pin 5 (Configurable)
Installation
------------
Clone the repository with:
```bash
git clone https://github.com/sophiekovalevsky/rfid.git
```
And place the repo into the your arduino libraries folder.
Credits
-----
This library was created by [Miguel Balboa.][1]
More comming soon.
-----
We need to document a lot.
[1]: https://github.com/miguelbalboa