diff --git a/README.md b/README.md index 3280739..4725d58 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,118 @@
- + tranquill logo

tranquill

Real-time automated typing bot for Google Chrome.

-
\ No newline at end of file + + +

Overview

+

+ tranquill is a real-time automated typing bot designed to work seamlessly with Google Chrome. This extension allows you to automate typing tasks on websites such as Google Docs, simulating human-like typing while doing so. + + Using tranquill, you can create realistic edit history on your documents, rather than pasting and having everything appear at once. +

+ +

Features

+ + +

Installation

+

+ tranquill is currently not available in the Chrome Web Store. To install the extension, you will need to load it locally in Developer Mode. Follow the steps below: +

+ +

Step 1: Download the Extension Files

+
    +
  1. Clone or download the tranquill repository from GitHub.
  2. +
  3. Extract the ZIP file if you downloaded the files as an archive.
  4. +
+ +

Step 2: Enable Developer Mode in Chrome

+
    +
  1. Open Google Chrome.
  2. +
  3. Navigate to chrome://extensions/.
  4. +
  5. In the top right corner, toggle the switch to enable Developer mode.
  6. +
+ +

Step 3: Load the Extension

+
    +
  1. Click on the Load unpacked button in the top left corner.
  2. +
  3. In the file dialog, navigate to the folder where you extracted the tranquill files.
  4. +
  5. Select the folder and click Open.
  6. +
  7. The tranquill extension should now appear in your list of extensions.
  8. +
+ +

Step 4: Verify Installation

+
    +
  1. Ensure that the tranquill extension is enabled by checking the toggle switch next to its name in the list of extensions.
  2. +
  3. Click on the tranquill icon in the Chrome toolbar to open the extension popup and begin using it.
  4. +
+ +

Usage

+

+ tranquill is designed to be intuitive and easy to use, with a focus on automating typing tasks in real-time. Here’s a step-by-step guide on how to use it: +

+ +

Step 1: Open the Extension Popup

+

+ Click on the tranquill icon in the Chrome toolbar to open the extension's popup interface. +

+ +

Step 2: Enter Text

+

+ In the popup, you will see a text input field labeled "Text Queue". Enter or paste the text that you want tranquill to type. Then, press the blue Save button. +

+ +

Step 3: Start Typing

+

+ Click the green Start button. tranquill will begin typing the text into the active element on the webpage. The typing speed and behavior will mimic human typing, including natural delays between keystrokes. +

+ +

Step 4: Stop Typing

+

+ If you need to stop the typing process, simply click the red Stop button in the popup. +

+ +

Step 5: Resetting the Input

+

+ If you want to clear the text queue, click the gray Reset button. This will clear the input field and stop any ongoing typing tasks. +

+ +

Update Notifications

+

+ tranquill includes a built-in update notification system that checks for new versions each time the service worker is activated. If a new version is detected, the default popup is set to an update notification page, prompting you to update. +

+ +

How to Update

+
    +
  1. When an update is available, the extension will automatically show an Update Required page.
  2. +
  3. Click the Update Now button to visit this repository, and follow the installation instructions found above.
  4. +
+ +

Troubleshooting

+ +

+ For more detailed troubleshooting, please visit the issues section of this repository. +

+ +

License

+

+ tranquill is licensed under the MIT License. See the LICENSE file for more details. +

+ +

Contributing

+

+ We welcome contributions from the community! If you'd like to contribute, please fork the repository, create a new branch, and submit a pull request with your changes. +

+
+
+

Happy Typing with tranquill!

+ tranquill logo +
diff --git a/js/version-check.js b/js/version-check.js index f539cad..cdcbdff 100644 --- a/js/version-check.js +++ b/js/version-check.js @@ -24,7 +24,7 @@ async function versionCheck() { return true; // New version is available } } catch (error) { - return true; // Assume there's an update to prevent potential issues + return false; // Work anyway, without internet. } return false; // No new version available } diff --git a/manifest.json b/manifest.json index 2027e16..4d6f17d 100644 --- a/manifest.json +++ b/manifest.json @@ -2,7 +2,7 @@ "manifest_version": 3, "name": "tranquill", "description": "Real-time automated typing bot for Google Chrome.", - "version": "1.0.7", + "version": "1.0.8", "icons": { "16": "./assets/images/icon_16x.png", "48": "./assets/images/icon_48x.png",