From 42eee8b4424d2d0facab8db36e5bded75a494fdd Mon Sep 17 00:00:00 2001
From: Kumi <git@kumi.email>
Date: Fri, 16 Sep 2022 08:13:48 +0000
Subject: [PATCH] Update README.md

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.md b/README.md
index e69de29..9f6dca7 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,36 @@
+# pyCruiseMapper
+
+Python package for retrieving data on (cruise) ships from cruisemapper.com
+
+This is a very basic implementation, and it might stay like this, but I still
+wanted to share it in case anyone finds it useful. I can't promise that I will
+keep this package updated or that it's going to work forever as is, though.
+
+## Basic Usage
+
+```python
+from pycruisemapper import CruiseMapper
+
+cruisemapper = CruiseMapper()
+
+# First, retrieve basic data on all ships
+# Returns a list of Ship objects
+
+all_ships = cruisemapper.get_ships()
+
+# Then, select the ship(s) you are interested in from that list
+
+meinschiff1 = list(filter(lambda x: x.imo == 9783564))[0]
+
+# You may want to retrieve additional information of a ship's current status
+# Pass the Ship object into fill_ship and it will return an object with details
+
+meinschiff1 = cruisemapper.fill_ship(meinschiff1)
+
+# You can now access things like the current location or temperature
+
+location = meinschiff1.location # .latitude/.longitude
+temperature = meinschiff1.current_temperature # returned in °C
+
+# Check the class definitions in /classes/*.py to see all possible attributes
+```
\ No newline at end of file