Skip to content

Commit

Permalink
minor readme updates (#9)
Browse files Browse the repository at this point in the history
minor readme updates
  • Loading branch information
jonfriesen committed Aug 24, 2024
1 parent c247fa7 commit 3d51dea
Showing 1 changed file with 5 additions and 20 deletions.
25 changes: 5 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,7 @@

QuickCite is a Chrome extension designed to enhance productivity by allowing users to quickly copy formatted information from various websites, including GitHub, LinkedIn, and Instagram.

## [Add to Chrome](https://chromewebstore.google.com/detail/quickcite/bdkbkefnpcenapogkehakcgmffjbbkif)

## Table of Contents

- [Features](#features)
- [Supported Websites](#supported-websites)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Development](#development)
- [Building](#building)
- [Installing the Unpacked Extension in Chrome](#installing-the-unpacked-extension-in-chrome)
- [Releasing](#releasing)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
<span style="font-size: 1.5em; font-weight: normal;">✨ <a href="https://chromewebstore.google.com/detail/quickcite/bdkbkefnpcenapogkehakcgmffjbbkif">Add to Chrome</a> ✨</span>

## Features

Expand Down Expand Up @@ -67,7 +52,7 @@ After installation, the QuickCite button will appear on supported pages. Click t

For frequently asked questions and user support, please refer to our [FAQ document](docs/FAQ.md).

## Development
### Development

To run the extension in development mode:

Expand All @@ -79,7 +64,7 @@ This will start the Vite development server and watch for file changes.

**Note:** Hot Module Reload (HMR) in this project is inconsistent and often only works for the content and popup sections. You may need to manually refresh the extension or the page to see changes in other parts of the extension.

## Building
### Building

To build the extension for production:

Expand All @@ -89,7 +74,7 @@ npm run build

This will create a production-ready build in the `dist` directory.

## Installing the Unpacked Extension in Chrome
### Installing the Unpacked Extension in Chrome

After building the extension, follow these steps to install it as an unpacked extension in Chrome:

Expand All @@ -101,7 +86,7 @@ After building the extension, follow these steps to install it as an unpacked ex

**Note:** When you make changes to the extension, you'll need to rebuild it and then click the "**Reload**" button on the extension card in `chrome://extensions/` to update the installed version.

## Releasing
### Releasing

To release a new version of the extension, run the following command:

Expand Down

0 comments on commit 3d51dea

Please sign in to comment.