commit 2fc31b3147089c1fd5bbddc1cb2e7d711272ceb9
parent 7b939cf5038a103935a208dbef3d1672ff0604be
Author: Bharatvaj <bharatvaj@yahoo.com>
Date: Thu, 9 Jun 2022 06:07:06 +0530
Add README.asc
Remove README.rst
Diffstat:
| A | README.asc | | | 54 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| D | README.rst | | | 65 | ----------------------------------------------------------------- |
2 files changed, 54 insertions(+), 65 deletions(-)
diff --git a/README.asc b/README.asc
@@ -0,0 +1,54 @@
+== qlic
+
+qlic is an unecessarily fast cli frontend to the venereal Zoho cliq. It is cliq but unopinionated.
+
+=== Why?
+
+I avoid browsers like the plague. Zoho cliq was my only reason for using a browser. Not anymore.
+
+=== Usage
+==== Sending a text
+
+ echo "Hey" | qlic -r client_id
+ qlic -r client_id "Hey"
+
+==== Sending an attachment
+ cat image.jpg | qlic -r client_id -b image.jpg
+
+=== What works
+
+* Authentication via OAuth
+* Receive and send text to chat, channels
+* Receive and send attachments to chat, channels
+
+=== What doesn't work
+
+* Cliq call - Apparently this takes more work than I thought.
+* Screenshare - Sharing screen is top priority for qlic, but it requires call to work first.
+* Widgets - I have no interest in implementing widgets in a cli as it
+doesn't benefit me, but contributions are welcome as always.
+
+=== Install
+
+ git clone https://github.com/bharatvaj/qlic
+ cd qlic
+ make install
+
+=== Dependencies
+
+* libcurl
+* bharatvaj/OAuth2
+* yarosla/nxjson
+
+=== Setup
+
+Create a config file at $XDG_DATA_HOME/qlic/data.json with the following configuration
+
+ {
+ "user_id": {
+ "client_id": "<zoho_client_id>",
+ "client_secret": "<zoho_client_secret>"
+ }
+ }
+
+NOTE: client id and secret can be obtained from https://api-console.zoho.com/
diff --git a/README.rst b/README.rst
@@ -1,65 +0,0 @@
-qlic
-====
-
-qlic is an unecessary fast cli frontend to the venereal Zoho cliq. It is cliq but unopinionated.
-
-NOTE: Built with bubble gum and paper clip. Highly unstable, please use at your own risk.
-
-
-
-Why?
-----
-I avoid browsers like the plague. Zoho cliq was my only reason for using a browser. Not anymore.
-
-What works
-----------
-* Authentication via OAuth
-* Receive and send text to chat, channels
-* Receive and send attachments to chat, channels
-
-What doesn't work
------------------
-* Cliq call - Apparently this takes more work than I thought.
-* Screenshare - Sharing screen is top priority for qlic, but it requires call to work first.
-* Widgets - I have no interest in implementing widgets in a cli as it doesn't benefit me, but contributions are welcome as always.
-
-Unique features
----------------
-* stdin support!
- - You can send attachment to qlic's `stdin`
-```sh
-# NOTE: `nwoo` is the recipient
-# qlic tries to match with the closest name, if it matches with multiple names, a prompt will be shown to the user
-
-# Sending a text
-echo "hello fren" | qlic -r nwoo
-qlic -r nwooo "henlo fren"
-
-# Sending an attachment
-cat how-to-basic-101.jpg | qlic -r nwoo -b meme.jpg
-```
-
-Install
--------
-```sh
-git clone https://github.com/bharatvaj/qlic
-cd qlic
-make install
-```
-
-Dependencies
-------------
-* libcurl
-* bharatvaj/OAuth2
-* yarosla/nxjson
-
-Setup
------
-* Create a config file at `$XDG_DATA_HOME/qlic/data.json` with the following configuration
-```json
-{
- client_id: 'your_client_id',
- client_secret: 'your_client_secret',
-}
-```
-NOTE: client id and secret can be obtained from [Zoho's API console](https://api-console.zoho.com/)
