Chrome extension to write README.md files for GitHub repos

Latest Version

Version
1.0.0
Update
August 2, 2023
Size
117KiB
Developer
Category
Users
216
Rating
3 ★
Manifest Version
3
Web Store Status
Languages Support
English
See more
Permissions
Tabs
Storage
Cookies
See more

README Writer Extension

README-GPT: Automatic README Generator with AI Assistance

README-GPT is an innovative Chrome extension that takes the hassle out of writing project READMEs. With AI-powered assistance, it generates comprehensive, informative, and visually appealing README.md files, saving you valuable time and effort.

Features:

Seamless Integration: Easily integrate README-GPT into your Chrome browser to access it whenever you need to create or update your project's README file.

AI-Generated Content: Leverage the power of OpenAI's GPT-3 to automatically generate descriptive content for your project's introduction, features, installation guide, usage instructions, and more.

Customization Options: Tailor the README output to match your project's unique requirements, including license information, environment details, and open contribution policies.

Visual Appeal: Add images, badges, and GIFs to make your README visually engaging and captivating for your users.

How to Use:

Install the README-GPT Chrome extension.
Click on the extension icon to open the generator.
Enter your project details, such as name, features, license, environment, and more.
Customize the generated content to fit your project's specific needs.
Download or copy the generated README.md file and add it to your project repository.
Why Choose README-GPT:

Time-Saving: Say goodbye to manual README writing and let AI do the heavy lifting for you.

Consistency: Maintain a consistent and professional look for all your projects' README files.

Engaging Documentation: Impress your users with visually appealing READMEs that effectively explain your project's purpose and functionalities.

OpenAI Integration: Benefit from state-of-the-art natural language processing and content generation through OpenAI's GPT-3.

Try README-GPT now and revolutionize the way you create project documentation!

Disclaimer: README-GPT is an independent project and not affiliated with OpenAI. The AI-generated content provided by the extension is based on user inputs and may require review and editing for accuracy and clarity.
Read more

Source Manifest.json

{"update_url": "https://clients2.google.com/service/update2/crx", "name": "README Writer", "version": "1.0.0", "manifest_version": 3, "description": "Chrome extension to write README.md files for GitHub repos", "icons": { "48": "icons/logo48.png", "128": "icons/logo128.png" }, "content_scripts": [ { "matches": ["https://github.com/*"], "run_at": "document_idle", "all_frames": false, "js": ["./content.js"] } ], "background": { "service_worker": "./background.js", "type": "module" }, "host_permissions": ["https://github.com/*", "https://readme-gpt-lemon.vercel.app/"], "action": { "default_popup": "popup.html" }, "permissions": [ "tabs", "storage", "cookies" ]}
Read more

How to download and manually install README Writer extension for Chrome

Looking for a way to install README Writer extensions for Chrome, you can search for them in the Chrome Web Store, clicking the "Add to Chrome" button, and following the straightforward process.

However, you may need to install README Writer extensions manually, this article outlines two simple methods to effortlessly install README Writer extensions, whether they come as unpacked folders in compressed formats like .zip or as .crx files.

Method 1: Download README Writer extension and manually install through Drag &Drop

If you ever need to manually install a README Writer extension for Chrome, don't worry, it's a simple process. Just follow these easy steps, and you will have your extension ready to use in no time.

Step 1: Download the README Writer Extension by clicking the "Download CRX" button on the website.

Look for the README Writer extension you wish to install. Go to the website and download the README Writer extension package, which is usually a .CRX file and comes in a zipped file. Here ".crx" file is the format for README Writer extension that contains all the data.

Step 2: Extract &Arrange Files

Once the file is downloaded, extract that file into its own folder. Similarly, give that extension files a permanent home. In other words, keep it in a folder that you don't accidentally delete it because these files will be needed to make that extension work.

Step 3: Go to the Chrome Extensions Page

Open Google Chrome and in the address bar, type chrome://extensions; it will open the Google Chrome extensions page. Make sure that "My extensions" is selected in the sidebar.

Step 4: Drag and Drop the Extension

Now, go to the folder where you extracted the README Writer extension and drag &drop the extension file from there anywhere onto the extension page within Google Chrome.

Step 5: Complete the Installation

Once you drag and drop the extension file, follow the steps that Google Chrome takes you through. Similarly, if the extension file is of .crx file format, you will be required to review the permissions and then add the extension.

Now, you can manage that added extension as you would like to with any other Chrome extension that you added through Chrome Webstore. Its icon will also appear in the Google Chrome Menu on the right side of the address bar once you activate it.

Method 2: Download README Writer extension for Chrome and install in Developer Mode

This is another method to install README Writer extension manually, but the twist is that here, you install by enabling the developer mode option provided in Google Chrome. This mode is commonly used for testing extensions or running unpublished tools.

Step 1: Download the README Writer extension file

Select and download the README Writer extension by clicking the 'Download CRX' button on the website.

Step 2: Extract the downloaded contents

Convert the file to a ZIP file if it is in CRX format then extract the README Writer extension zip file or folder that you downloaded. Make sure you extract it using the same folder name and keep it safely in another folder, so you don't delete it by mistake. The extracted folder will be needed to keep your README Writer extension running.

Step 3: Open Chrome Extension Setting Page

In the address bar of Google Chrome, type chrome://extensions and open the Chrome Extension Page.

Step 4: Enable Developer Mode

After opening the Chrome Extension page, look at the top right side, and you will find the toggle option of "Developer mode."Simply enable that developer mode option.

Step 5: Load the Unpacked Extension

Once you enable the developer mode option, you will see the menu of Load Unpacked, Pack Extensions and Update. From that, select the option "Load unpacked."

Step 6: Select the Extension Folder

Once the pop-up opens upon clicking Load unpacked, select the README Writer extension directory and click on the "Select Folder "button.

Step 7: Confirm and Install

After you select an extension folder of a Google Chrome extension you're installing manually, confirm its installation for the final time and let the installation complete.

Conclusion

Here we've made a step-by-step guide on How to manually install README Writer extension in 2 ways. We hope this guide proves helpful.

Similar Extensions

icon

Github Godoc Extension · Developer Tools 216 1 ★ 24.68KiB

icon

inCreator Extension · Productivity 216 5 ★ 2.27MiB

icon

7plus-responsive-video Extension · Accessibility 216 0 ★ 3.34KiB

icon

PimpMyBB Extension · Productivity 216 0 ★ 1.13MiB

icon

Swashbuckle Swagger UI Autofill Helper Extension · Developer Tools 216 0 ★ 6.01KiB

icon

Launcher Tab Closer Extension · Productivity 216 0 ★ 82.29KiB

icon

Levvy Password Manager Extension · Productivity 216 3 ★ 2.46MiB

icon

Twitter Reaction Counter Extension · Social & Communication 216 0 ★ 133KiB

icon

Twitter Intro Finder Extension · Productivity 216 2 ★ 376KiB

icon

TitlePage Express Extension · Productivity 216 2 ★ 455KiB

icon

Tanuki Utilities Extension · Developer Tools 216 1 ★ 25.43KiB

icon

ChatGPT AutoContinuer Extension · Productivity 216 0 ★ 10.28KiB

icon

GitHub PR images comparer Extension · Developer Tools 216 1 ★ 13.65KiB

icon

Thin_promotions Extension · Accessibility 216 1 ★ 42.7KiB

icon

Fair Price Tracker Extension · Shopping 216 0 ★ 55.61KiB

icon

Swish QR-code generator Extension · Accessibility 216 0 ★ 141KiB

icon

GPT Summary Extension · Productivity 216 0 ★ 17.24KiB

icon

Twitter View Count Remover Extension · Social & Communication 216 5 ★ 141KiB

icon

Clear Portal Cache Extension · Developer Tools 216 1 ★ 60.0KiB

icon

Krunch Extension · Developer Tools 216 2 ★ 218KiB

icon

uli Extension · Social & Communication 216 2 ★ 2.16MiB

icon

Retaino Extension · Productivity 216 2 ★ 443KiB

icon

DOU enhancer Extension · Social & Communication 216 0 ★ 3.9MiB

icon

Tweet creator Extension · Productivity 216 4 ★ 6.47MiB

User reviews

icon

Arslan Akishev (ID: 0000007ae4a9c284) Voted 5 ★ - Updated 08/08/2023 Лучшее расширение