From a08bed99b174bfe156d311b872a1b879da81f97e Mon Sep 17 00:00:00 2001
From: David Blajda <blajda@hotmail.com>
Date: Thu, 3 May 2018 15:43:57 -0400
Subject: README markdown compliant

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7fd78e6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# DS1302 Library for the Raspberry Pi
+
+This is a library for interacting with the serial interface of a DS1302 with a Raspberry Pi.
+Serial communications is bit banged instead of using the Pi's SPI pins to allow flexibility when setting up.
+Single register read and write operations are supported and burst read and write operations on clock and ram registers are also supported.
+Additional utilities for manipulating `struct tm` on the device is also provided.
+
+## Requirements
+bcm2835 library <http://www.airspayce.com/mikem/bcm2835/index.html>
+
+## References
+
+DS1302 Datasheet <https://datasheets.maximintegrated.com/en/ds/DS1302.pdf>
+bcm2835 arm peripherals <https://www.raspberrypi.org/app/uploads/2012/02/BCM2835-ARM-Peripherals.pdf>
-- 
cgit v1.2.3