Initailize repository

1 files changed, 14 insertions, 0 deletions

diff --git a/readme b/readme
new file mode 100644
index 0000000..7fd78e6
--- /dev/null
+++ b/readme
@@ -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>