Release Version 2.2.3 (public)

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at brandon1024.br@gmail.com. The project
+team will review and investigate all complaints, and will respond in a way that
+it deems appropriate to the circumstances. The project team is obligated to
+maintain confidentiality with regard to the reporter of an incident. Further
+details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing to {find+}
+
+We need help! We feel this project has great potential, but there is a lot of
+work to go around. If you are interested in becoming a contributor, reading this
+document should help you get started.
+
+All contributions from the community must follow the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Reporting an Issue
+
+Did you notice an issue? We probably missed something. Let us know by [opening
+an issue](https://github.com/brandon1024/find/issues). Be sure to check whether
+the issue has already been brought up (expand upon the issue if you have more
+details), or whether the issue has been fixed in a new release.
+
+In creating a new issue, ensure you use a succinct title, full description, and
+images if applicable.
+
+If you think you can fix the issue yourself, follow the steps to become a
+contributor. If you feel the issue is outside of your comfort zone, you can
+mention someone in the description or assign the issue to another developer.
+
+## Making Changes
+
+Our project follows the git-flow. This means that we have a `master`
+(stable-release) branch, and a `develop` (beta) branch. All proposed changes
+must be targeted at the `develop` branch.
+
+Once you create a fork of this repository, you can make your changes on a
+feature branch and open a pull request to the upstream project when it's ready.
+
+Once you think your changes are ready to be merged, create a pull request. Use a
+succinct title, full description, and images if applicable. Linking a pull
+request to the original issue helps the reviewer when testing your changes.
+Provide a description of how you tested your changes locally. Another developer
+will review your changes, provide feedback, and merge once everything looks
+good.
+
+## Reviewing a Pull Request
+
+Code reviews plays an important part of our development cycle. As a reviewer,
+it's important to check that fixes/functionality is working as described, that
+the changes follow good style guidelines, and that the changes provide value to
+the project.

.github/PRIVACY.md → PRIVACY.md

@@ -1,8 +1,9 @@
 # Find+ Privacy Policy
+
 Find+ does not collect any data of any kind.
 
-- Find+ is run on the client, only. There are no external servers hosted to support this extension.
+- Find+ is run on the client, only. There are no external servers hosted to
+  support this extension.
 - Find+ doesn't embed any kind of analytic or telemetry hooks in its code.
 - Find+ doesn't accept donations or any other form of financing.
 - Find+ doesn't make any web requests to any third party servers.
-

.github/README.md → README.md

@@ -1,39 +1,55 @@
-<img src="../resources/icon.png" align="right" width="128" />
+<img src="resources/icon.png" align="right" width="128" />
 
 # **{find+}**
-![Chrome Users](https://img.shields.io/chrome-web-store/users/fddffkdncgkkdjobemgbpojjeffmmofb.svg?style=flat&label=chrome%20users)
-![Firefox Users](https://img.shields.io/amo/users/brandon1024-find.svg?label=firefox%20users&style=flat)
-![Last Commit on GitHub](https://img.shields.io/github/last-commit/brandon1024/find.svg?style=flat)
 
-**{find+}** is a powerful _find-in-page_ extension for Chrome and Firefox that allows you to search for content in a web page or document by regular expression. It is a feature-rich alternative to the native _find-in-page_ tool built into your browser. 
+[![Chrome Users](https://img.shields.io/chrome-web-store/users/fddffkdncgkkdjobemgbpojjeffmmofb.svg?style=flat&label=chrome%20users)](https://chrome.google.com/webstore/detail/find%2B/fddffkdncgkkdjobemgbpojjeffmmofb)
+[![Firefox Users](https://img.shields.io/amo/users/brandon1024-find.svg?label=firefox%20users&style=flat)](https://addons.mozilla.org/en-US/firefox/addon/brandon1024-find/)
+[![Last Commit on GitHub](https://img.shields.io/github/last-commit/brandon1024/find.svg?style=flat)](https://github.com/brandon1024/find/commits/develop)
+
+**{find+}** is a powerful _find-in-page_ extension for Chrome and Firefox that
+allows you to search for content in a web page or document by regular
+expression. It is a feature-rich alternative to the native _find-in-page_ tool
+built into your browser.
 
 Some notable features:
+
 - match a regular expression against text in a web page
 - quickly search for text using the browser omnibox
 - find and replace text in a page
 - copy occurrences of a regular expression to your clipboard
 - store frequently-used patterns
 - adjust colours and search settings
 
-![](screencast.gif)
 
 ## Getting Started
-The **{find+}** extension is available through the Chrome Web Store and through the Firefox Add-ons Store.
 
-<img src="chrome-icon.png" width="16"/> Download the extension here: [find+ | Regex Find-in-Page Tool](https://chrome.google.com/webstore/detail/find%2B/fddffkdncgkkdjobemgbpojjeffmmofb).
+The **{find+}** extension is available through the Chrome Web Store and through
+the Firefox Add-ons Store.
+
+<img src=".github/chrome-icon.png" width="16"/> Download the extension here: [find+ | Regex Find-in-Page Tool](https://chrome.google.com/webstore/detail/find%2B/fddffkdncgkkdjobemgbpojjeffmmofb).
 
-<img src="firefox-icon.png" width="16"/> Download the extension here: [{find+} – Get this Extension for 🦊 Firefox](https://addons.mozilla.org/en-US/firefox/addon/brandon1024-find/).
+<img src=".github/firefox-icon.png" width="16"/> Download the extension here: [{find+} – Get this Extension for 🦊 Firefox](https://addons.mozilla.org/en-US/firefox/addon/brandon1024-find/).
 
 ## Keyboard Shortcuts
-In Firefox, you can use <kbd>CTRL</kbd>+<kbd>⇧</kbd>+<kbd>F</kbd> to open the extension popup. 
 
-To open the extension popup in Chrome using a keyboard shortcut, you must first assign a keyboard shortcut to the extension through the Chrome settings. You can do this by following these steps:
-1. Navigate to the `Extensions` settings page in Chrome, or type `chrome://extensions/` into the navigation bar.
+In Firefox, you can use <kbd>CTRL</kbd>+<kbd>⇧</kbd>+<kbd>F</kbd> to open the
+extension popup.
+
+To open the extension popup in Chrome using a keyboard shortcut, you must first
+assign a keyboard shortcut to the extension through the Chrome settings. You can
+do this by following these steps:
+
+1. Navigate to the `Extensions` settings page in Chrome, or type
+   `chrome://extensions/` into the navigation bar.
 2. In the top left click on the ☰ menu icon, then click `Keyboard shortcuts`.
-3. Locate the shortcut settings for find+. Click the input field located to the right of the label `Activate the extension`.
-4. Press the combination of keys you would like to use, and once complete press `OK`. We recommend using <kbd>CTRL</kbd>+<kbd>⇧</kbd>+<kbd>F</kbd>, since it shouldn't conflict with any other browser keyboard shortcut mappings.
+3. Locate the shortcut settings for find+. Click the input field located to the
+   right of the label `Activate the extension`.
+4. Press the combination of keys you would like to use, and once complete press
+   `OK`. We recommend using <kbd>CTRL</kbd>+<kbd>⇧</kbd>+<kbd>F</kbd>, since it
+   shouldn't conflict with any other browser keyboard shortcut mappings.
 
-When the extension popup is open, there are a number of keyboard shortcuts you can use. These settings cannot be remapped.
+When the extension popup is open, there are a number of keyboard shortcuts you
+can use. These settings cannot be remapped.
 
 | Windows Shortcut                                   | macOS Shortcut                                     | Action                                                                 |
 | :------------------------------------------------- | :------------------------------------------------- | :--------------------------------------------------------------------- |
@@ -48,18 +64,28 @@ When the extension popup is open, there are a number of keyboard shortcuts you c
 | <kbd>CTRL</kbd>+<kbd>↵</kbd> or <kbd>ESC</kbd>     | <kbd>^</kbd>+<kbd>↵</kbd> or <kbd>ESC</kbd>        | Close the extension popup                                              |
 
 ## Omnibox Support
-In version 1.4.0, we introduced omnibox support! This allows you to highlight text on a page without even opening the extension. To use this feature, type `find` in your browser's address bar, press <kbd>␣</kbd> or <kbd>⇥</kbd>, and then enter a regular expression. Occurrences of the regular expression will become highlighted on the page as you type.
 
-Pressing `ENTER` will leave the highlights in the page. To remove the highlights, simply refresh the page. If you don't want to leave the highlights in the page, just erase the text entered in the address bar.
+In version 1.4.0, we introduced omnibox support! This allows you to highlight
+text on a page without even opening the extension. To use this feature, type
+`findplus` in your browser's address bar, press <kbd>␣</kbd> or <kbd>⇥</kbd>,
+and then enter a regular expression. Occurrences of the regular expression will
+become highlighted on the page as you type.
 
-<img src="omni.png"/>
+Pressing `ENTER` will leave the highlights in the page. To remove the
+highlights, simply refresh the page. If you don't want to leave the highlights
+in the page, just erase the text entered in the address bar.
+
+<img src=".github/omni.png"/>
 
 ## Contributing
-We can use your help! Our [CONTRIBUTING](CONTRIBUTING.md) doc should help get you started.
+
+We can use your help! Our [CONTRIBUTING](CONTRIBUTING.md) doc should help get
+you started.
 
 ## Contributors
-[<img src="https://avatars3.githubusercontent.com/u/22732449?v=3&s=460" width="64" style="border-radius:50%">](https://github.com/brandon1024) [<img src="https://avatars3.githubusercontent.com/u/25009878?s=460&u=ba1d4eb8abb2ad96c514aeb911adf1b34949e32f&v=4" width="64" style="border-radius:50%">](https://github.com/MichaelWalz) [<img src="https://avatars3.githubusercontent.com/u/184316?s=460&u=beed843205b1fd652277562e715f517d3082b4be&v=4" width="64" style="border-radius:50%">](https://github.com/muescha) [<img src="https://avatars3.githubusercontent.com/u/7383028?s=460&v=4" width="64" style="border-radius:50%">](https://github.com/amit-gshe) [<img src="https://avatars2.githubusercontent.com/u/8235338?s=460&v=4" width="64" style="border-radius:50%">](https://github.com/ReporterX)
+
+[<img src="https://avatars3.githubusercontent.com/u/22732449?v=3&s=460" width="64" style="border-radius:50%">](https://github.com/brandon1024) [<img src="https://avatars3.githubusercontent.com/u/25009878?s=460&u=ba1d4eb8abb2ad96c514aeb911adf1b34949e32f&v=4" width="64" style="border-radius:50%">](https://github.com/MichaelWalz) [<img src="https://avatars3.githubusercontent.com/u/184316?s=460&u=beed843205b1fd652277562e715f517d3082b4be&v=4" width="64" style="border-radius:50%">](https://github.com/muescha) [<img src="https://avatars3.githubusercontent.com/u/7383028?s=460&v=4" width="64" style="border-radius:50%">](https://github.com/amit-gshe) [<img src="https://avatars2.githubusercontent.com/u/8235338?s=460&v=4" width="64" style="border-radius:50%">](https://github.com/ReporterX) [<img src="https://avatars.githubusercontent.com/u/29089388?v=4" width="64" style="border-radius:50%">](https://github.com/pzhlkj6612)
 
 ## License
-This project is licensed under the [GPLv3 License](https://www.gnu.org/licenses/gpl-3.0.en.html).
 
+This project is licensed under the [GPLv3 License](https://www.gnu.org/licenses/gpl-3.0.en.html).