Diff: README.md

Revision:

0:9a16c3f036b0

Child:

1:6c82b777db0b

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Mon Sep 24 17:09:42 2018 +0100
@@ -0,0 +1,49 @@
+# NFC SmartPoster example
+
+Demonstration of possible usage of the the `NFCController` class.
+
+The application creates a smart poster record and sends it when a connected peer requests it.
+The smart poster record generated contains:
+- A URI: https://www.mbed.com
+- A title: "mbed website"
+- An action: `EXECUTE` which asks the peer to open the URI.
+
+# Running the application
+
+## Requirements
+
+Verification of the sample application can be seen on any a smartphone with an NFC reader. After running you will be able to read the tag with an NFC tag reader application.
+
+Information about activity is also printed over the serial connection - please have a client open. You may use:
+
+- [Tera Term](https://ttssh2.osdn.jp/index.html.en)
+
+This example is known to work on boards connected to a PN512 shield.
+
+## Building instructions
+
+Clone the repository containing the collection of examples:
+
+```
+git clone https://github.com/ARMmbed/mbed-os-example-nfc.git
+```
+
+Using a command-line tool, navigate to the exmaple:
+
+```
+cd mbed-os-example-nfc
+cd NFC_SmartPoster
+```
+
+Update the source tree:
+
+```
+mbed deploy
+```
+
+Run the build:
+
+```
+mbed compile -t <ARM | GCC_ARM> -m <YOUR_TARGET>
+```
+