Diff: README.md

Revision:

0:fcb1e0b995a9

Child:

1:916188eae2bb

diff -r 000000000000 -r fcb1e0b995a9 README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Thu Mar 08 18:08:23 2018 +0000
@@ -0,0 +1,27 @@
+# SM - example usage of the Security Manager to pair and encrypt
+
+Demonstration of possible usage of the Security Manager. Security Manager deals with pairing, authentication and encryption.
+
+The application demonstrates usage as a central and a peripheral. The central will connect to any connectable device present. Please have one ready and advertising. Application will attempt pairing. Please authorise your peer device to pair.
+
+Upon success it will disconnect and start advertising to demonstrate usage as a peripheral. Please scan and connect using your peer device. Upon connection grant pairing if prompted. Upon success the application will disconnect. Observe the terminal to keep track of the sequence. 
+
+# Running the application
+
+## Requirements
+
+The sample application can be seen on any BLE scanner on a smartphone. If you don't have a scanner on your phone, please install :
+
+- [nRF Master Control Panel](https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp) for Android.
+
+- [LightBlue](https://itunes.apple.com/gb/app/lightblue-bluetooth-low-energy/id557428110?mt=8) for iPhone.
+
+Information about activity is printed over the serial connection - please have a client open. You may use:
+
+- [Tera Term](https://ttssh2.osdn.jp/index.html.en)
+
+Hardware requirements are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).
+
+## Building instructions
+
+Building instructions for all samples are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).