Merge pull request #2 from digitalfortress-dev/docs/update-readme

docs: update README.md

README.md

@@ -11,13 +11,37 @@
 
 # Git Repository Template
 
-## Usage
+## Getting Started
 
 Install package
-```
+```commandline
 pip install sqs-client
 ```
 
+## Example
+
+
+```python
+from sqs_client.client import SQSClient
+
+sqs_client = SQSClient()
+
+
+# Subscribe to an SQS
+@sqs_client.task(
+    queue_name="sqs-queue-name",
+    lazy=True,
+    wait_time_seconds=0,
+    visibility_timeout=300,
+)
+def test_task(message):
+    print("test_task received:", message)
+
+
+# Publish a message
+test_task.trigger("Test message")
+```
+
 ## License
 
 This project is Copyright (c) 2023 and onwards Digital Fortress. It is free software and may be redistributed under the terms specified in the [LICENSE] file.

examples/example.py

@@ -3,6 +3,7 @@
 sqs_client = SQSClient()
 
 
+# Subscribe to a SQS
 @sqs_client.task(
     queue_name="sqs-queue-name",
     lazy=True,
@@ -13,4 +14,5 @@ def test_task(message):
     print("test_task received:", message)
 
 
+# Publish a message
 test_task.trigger("Test message")