Updates to docs and descriptions

KuroLabs · May 3, 2020 · bccad5c · bccad5c
1 parent 36414e0
commit bccad5c
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 8 deletions.
diff --git a/PIP.md b/PIP.md
@@ -8,9 +8,9 @@
   <br>
 </h1>
 
-<h4 align="center">An easy way to share content in a local network using Multicast DNS.</h4>
+<h4 align="center">An easy way to share content in a local network using Multicast-DNS.</h4>
 
-<p align="justify"><b>Airshare</b> is a Python-based CLI tool and module that lets you transfer data between two machines in a local network, P2P, using Multicast DNS. It also opens an HTTP gateway for other non-CLI external interfaces. It works completely offline! Built with aiohttp and zeroconf.</p>
+<p align="justify"><b>Airshare</b> is a Python-based CLI tool and module that lets you transfer data between two machines in a local network, P2P, using Multicast-DNS. It also opens an HTTP gateway for other non-CLI external interfaces. It works completely offline! Built with aiohttp and zeroconf.</p>
 
 ## Important Links
 
@@ -27,6 +27,8 @@ Use the package manager [pip](https://pip.pypa.io/en/stable/) to install Airshar
 $ pip install Airshare
 ```
 
+If you have a non-Apple device, consider installing Avahi (for Linux) or Bonjour (for Windows) if you'd like to use Link-local Name Resolution (for the `.local` addresses).
+
 ## Example
 
 Send and receive files and directories.
@@ -48,12 +50,14 @@ You can also `import airshare` in any Python program. Visit the documentation fo
 
 ## Known Issues
 
-* The QR Code feature is not available on Windows. Terminals on Windows are unable to render QR Codes despite our extensive attempts and tests - let us know if you have a solution!
+* Link-local Name Resolution (for the `.local` addresses) on non-Apple devices requires Avahi (on Linux) or Bonjour (on Windows). Chances are you already have them, but if you don't, do check the web on how to install them.
 
-* Link-local Name Resolution, for example, `http://noobmaster.local`, does not work on Android phones. This is because Android browsers do not have inbuilt Multicast-DNS service discovery.
+* Link-local Name Resolution does not work on Android phones. This is because Android browsers do not have inbuilt Multicast-DNS service discovery.
 
 * Multiple progress bars for concurrent file uploads using `tqdm` may not work as intended on some terminals, refer to the `tqdm` documentation for more details.
 
+* Using `Ctrl` + `C` on Windows, with Python < 3.8, does not terminate the `asyncio` event loop. Use `Ctrl` + `Break` instead. If you do not have a `Break` or `Pause` key, some other combinations may work including `Ctrl` + `Fn` + `B` (check the web for solutions).
+
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 

diff --git a/README.md b/README.md
@@ -68,7 +68,7 @@ You can also `import airshare` in any Python program. Visit the documentation fo
 
 * Multiple progress bars for concurrent file uploads using `tqdm` may not work as intended on some terminals, refer to the `tqdm` documentation for more details.
 
-* Using <kbd>Ctrl</kbd> + <kbd>C</kbd> on Windows, with Python < 3.8, does not terminate the `asyncio` event loop. Use <kbd>Ctrl</kbd> + <kbd>Break</kbd> instead. If you do not have a <kbd>Break</kbd> or <kkbd>Pause</kbd> key, some other combinations may work including <kbd>Ctrl</kbd> + <kbd>Fn</kbd> + <kbd>B</kbd> (check the web for solutions).
+* Using <kbd>Ctrl</kbd> + <kbd>C</kbd> on Windows, with Python < 3.8, does not terminate the `asyncio` event loop. Use <kbd>Ctrl</kbd> + <kbd>Break</kbd> instead. If you do not have a <kbd>Break</kbd> or <kbd>Pause</kbd> key, some other combinations may work including <kbd>Ctrl</kbd> + <kbd>Fn</kbd> + <kbd>B</kbd> (check the web for solutions).
 
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

diff --git a/airshare/qrcode.py b/airshare/qrcode.py
@@ -6,8 +6,8 @@
 The word 'QR Code' is registered trademark of
 DENSO WAVE INCORPORATED
 http://www.denso-wave.com/qrcode/faqpatent-e.html
-Modified by Airshare Developers: added 
-printQr()
+Modified by Airshare Developers:
+  - added `printQr()` to `QRCode`
 """
 
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -97,7 +97,7 @@ Known Issues
 * Link-local Name Resolution (for the ``.local`` addresses) on non-Apple devices requires Avahi (on Linux) or Bonjour (on Windows). Chances are you already have them, but if you don't, do check the web on how to install them.
 * Link-local Name Resolution, for example, ``http://noobmaster.local``, does not work on Android phones. This is because Android browsers do not have inbuilt Multicast-DNS service discovery.
 * Multiple progress bars for concurrent file uploads using ``tqdm`` may not work as intended on some terminals, refer to the ``tqdm`` documentation for more details.
-
+* Using ``Ctrl`` + ``C`` on Windows, with Python < 3.8, does not terminate the ``asyncio`` event loop. Use ``Ctrl`` + ``Break`` instead. If you do not have a ``Break`` or ``Pause`` key, some other combinations may work including ``Ctrl`` + ``Fn`` + ``B`` (check the web for solutions).
 
 Contributing
 ------------