Merge pull request #13 from jameskabbes/0.3.0

0.3.0

.github/workflows/documentation.yml

@@ -34,20 +34,13 @@ jobs:
           "
 
       - name: Generate documentation
-        run: |
-          cd code/sphinx/
-          sphinx-apidoc -o . ../
-          make html
-          cd ../..
-
-      - name: Ensure docs directory exists
         run: |
           rm -rf docs
           mkdir docs
-
-      - name: Move documentation files
-        run: |
-          mv code/sphinx/_build/html/* docs
+          cd src/mac_imessage
+          sphinx-apidoc -o ../../docs ../
+          make html
+          cd ../..
 
       - name: Add .nojekyll file
         run: |

README.md

@@ -1,12 +1,14 @@
 # imessage
+
 Python tools for sending iMessage/SMS message from a Mac. Check out the blog post on medium related to this repository: [Medium](https://medium.com/@jameskabbes/sending-imessages-with-python-on-a-mac-b77b7dd6e371)
 
 [Documentation](https://jameskabbes.github.io/imessage) <br>
 [PyPI](https://pypi.org/project/pyimessage)
 
-<br> 
+<br>
 
 # Installation
+
 `pip install mac_imessage`
 
 <br>
@@ -21,27 +23,38 @@ python -m mac_imessage
 
 # Usage
 
-
 ```python
 import mac_imessage
 ```
 
 ## Basic Usage
+
 Check out `utils.py` for the most basic functionality
 
 ```python
-mac_imessage.send( 'This is a test message', '123-555-5555','iMessage' )
+mac_imessage.send(
+    message='This is a test message',
+    phone_number='123-555-5555',
+    medium='iMessage'
+    )
 ```
+
 ```python
-mac_imessage.send_SMS( 'This is a test message', '123-555-5555' )
+mac_imessage.send_sms(
+    message='This is a test message',
+    phone_number='123-555-5555',
+    )
 ```
 
 ```python
-mac_imessage.send_iMessage( 'This is a test message', '123-555-5555' )
+mac_imessage.send_imessage(
+    message='This is a test message',
+    phone_number='123-555-5555',
+    )
 ```
 
 <br>
 
 # Author
-James Kabbes
 
+James Kabbes