Merge pull request #31 from ttycelery/ttycelery-add-warning

Add a warning about the project status

README.md

@@ -1,25 +1,44 @@
+# Important Note
+
+**This project is no longer maintained**. As per this commit, I decided not to
+maintain the project anymore. Since last year, WhatsApp has been making many
+changes (most notably the offline feature) that directly affected this project.
+I have been so busy that I can't keep up with the pace, and I don't plan to
+continue it in the future either.
+
+Thanks to anyone who has been using and/or helping with the development of this
+project.
+
+If someone wants to continue the project (e.g. by making a fork), I would
+appreciate that.
+
 # Kyros
-Kyros, for now, is a Python interface to communicate easier with WhatsApp Web API.
-It provides an interface to connect and communicate with WhatsApp Web's websocket server.
-Kyros will handle encryption and decryption kind of things.
-In the future, Kyros is aimed to provide a full implementation of WhatsApp Web API which will give developers
-a clean interface to work with (more or less like [go-whatsapp](https://github.com/Rhymen/go-whatsapp)).
-This module is designed to work with Python 3.6 or latest.
-Special thanks to the creator of [whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng)
-and [go-whatsapp](https://github.com/Rhymen/go-whatsapp). This project is largely motivated by their work.
-Please note that Kyros is not meant to be used actively in production servers as it is currently not 
-production ready. Use it at your own risk.
+
+Kyros, for now, is a Python interface to communicate easier with WhatsApp Web
+API. It provides an interface to connect and communicate with WhatsApp Web's
+websocket server. Kyros will handle encryption and decryption kind of things. In
+the future, Kyros is aimed to provide a full implementation of WhatsApp Web API
+which will give developers a clean interface to work with (more or less like
+[go-whatsapp](https://github.com/Rhymen/go-whatsapp)). This module is designed
+to work with Python 3.6 or latest. Special thanks to the creator of
+[whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng) and
+[go-whatsapp](https://github.com/Rhymen/go-whatsapp). This project is largely
+motivated by their work. Please note that Kyros is not meant to be used actively
+in production servers as it is currently not production ready. Use it at your
+own risk.
 
 ## Installation
-Kyros could be installed by using `pip` or directly cloning it then invoking `setup.py`.
-For example, if you want to use pip, run the following command:
-```
-pip install git+https://[email protected]/ttycelery/kyros
-```
+
+Kyros could be installed by using `pip` or directly cloning it then invoking
+`setup.py`. For example, if you want to use pip, run the following command:
+
+ pip install git+https://[email protected]/ttycelery/kyros
 
 ## Documentation
+
 ### A simple example
-```python
+
+``` {.python}
 import asyncio
 import logging
 
@@ -34,10 +53,10 @@ logging.getLogger("kyros").setLevel(logging.WARNING)
 async def main():
  # create the Client instance using create class method
  whatsapp = await kyros.Client.create()
- 
+
  # do a QR login
  qr_data, scanned = await whatsapp.qr_login()
- 
+
  # generate qr code image
  qr_code = pyqrcode.create(qr_data)
  print(qr_code.terminal(quiet_zone=1))
@@ -49,7 +68,7 @@ async def main():
  # timed out (left unscanned), do a shutdown
  await whatsapp.shutdown()
  return
- 
+
  # how to send a websocket message
  message = kyros.WebsocketMessage(None, ["query", "exist", "[email protected]"])
  await whatsapp.websocket.send_message(message)
@@ -61,18 +80,23 @@ async def main():
 if __name__ == "__main__":
  asyncio.run(main())
 ```
-A "much more detailed documentation" kind of thing for this project is available [here](https://ttycelery.github.io/kyros/).
-You will see a piece of nightmare, happy exploring! Better documentation are being planned.
+
+A "much more detailed documentation" kind of thing for this project is available
+[here](https://ttycelery.github.io/kyros/). You will see a piece of nightmare,
+happy exploring! Better documentation are being planned.
 
 ## Contribution
-This work is still being slowly developed. Your contribution will of course
-make the development process of this project even faster. Any kind of contribution
-is highly appreciated.
+
+This work is still being slowly developed. Your contribution will of course make
+the development process of this project even faster. Any kind of contribution is
+highly appreciated.
 
 ## License
+
 This project is licensed with MIT License.
 
 ## Disclaimer
-This code is in no way affiliated with, authorized, maintained, sponsored
-or endorsed by WhatsApp or any of its affiliates or subsidiaries. This is
-an independent and unofficial software. Use at your own risk.
+
+This code is in no way affiliated with, authorized, maintained, sponsored or
+endorsed by WhatsApp or any of its affiliates or subsidiaries. This is an
+independent and unofficial software. Use at your own risk.