Skip to content

Commit

Permalink
Merge branch 'docReadme'
Browse files Browse the repository at this point in the history
  • Loading branch information
rugk committed Apr 28, 2021
2 parents 40f7527 + 5a7e5b6 commit 8123e09
Show file tree
Hide file tree
Showing 4 changed files with 126 additions and 12 deletions.
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,12 @@
<img height="200" width="200" src="assets/header.svg">

This is a (Firefox and Thunderbird) add-on (WebExtension) that allows you to autocorrect common text sequences and convert text characters to a look like a special font.
For instance, it converts quotes like `"these"` to `“these”`, which are typographically more correct.
For instance, it converts quotes like `"these"` to `“these”`, which are typographically correct.

In contrast to many other add-ons, …
Additionally, you can convert text into more than 20 different font styles and casing changes.
You can enable and disable any features in the options and adjust more settings regarding the behavior of the add-on.

It is/has/features…

It is inspired by …. This extension only works with modern Firefox and Thunderbird v78 or higher.
This extension only works with modern Firefox and Thunderbird v78 or higher.

## Download

Expand All @@ -29,9 +28,22 @@ See:
* [More screenshots](assets/screenshots)

## Features
* Puts your privacy first! Privacy is the default here.
* Unicode autocorrection as you type:
* Autocorrect [Unicode symbols](https://en.wikipedia.org/wiki/Miscellaneous_Symbols) (i.e. hyphens `--` with –, fractions `1/4` with ¼, etc.). Supports more than 85 symbols.
* Use Unicode smart quotes ('single quotes' with ‘Unicode single quotes’ and "double quotes" with “Unicode double quotes”)
* Convert [fractions](https://en.wikipedia.org/wiki/Number_Forms) and [mathematical constants](https://en.wikipedia.org/wiki/Mathematical_constant) to Unicode characters (i.e. `1234.25` with 1234¼, etc.). Supports all Unicode fraction characters, Pi and e constants.
* Supports undoing autocorrections
* Context menu with selected/highlighted text:
* [Unicode font](https://en.wikipedia.org/wiki/Mathematical_Alphanumeric_Symbols) conversion (i.e. ꜱᴍᴀʟʟ ᴄᴀᴘꜱ, 𝒮𝒸𝓇𝒾𝓅𝓉, 𝔉𝔯𝔞𝔨𝔱𝔲𝔯, etc.). Supports more than 20 fonts.
* Change [casing](https://en.wikipedia.org/wiki/Letter_case#Case_styles) (i.e. UPPER CASE, lower case, tOGGLE, cASE, etc.). Supports all locales.
* Optionally show a live preview.
* Useful on websites that do not support changing the font or text formatting.
* Support websites as best as possible by providing website-specific possibles, if needed. ([if there is a problem, please report it](https://github.com/rugk/unicodify/issues))
* Very fast, even when typing on large documents.
* Supports the light/dark mode of your system automatically.
* Settings automatically synced between all browser instances and devices (Firefox and Chrome only).
* Follows the [Firefox](https://design.firefox.com/photon) and [Thunderbird](https://style.thunderbird.net/) Photon Design.
* Has a simple, but intuitive and usable User Interface.
* Translated in several languages already. [Contribute your own language!](CONTRIBUTING.md#Translations)
* Compatible with Firefox for Android
* []
* Puts your privacy first and does not send data anywhere.
* Compatible with Firefox for Android.
* Translated into several languages. [Contribute your own language!](./CONTRIBUTING.md#Translations)
* Settings can be managed by your administrator.
1 change: 1 addition & 0 deletions assets/texts/amotags.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
transform, text, manipulate, change, upper case, lower case, casing, font, style, script, fractur, autocorrect, autocorrection, auto-correct, auto-correction, Unicode, symbol, ligature, ASCII, replace, type, autoformat, auto-format, format, hyphen, dash, fraction, quotes, smart quotes, ellipsis, arrow, math, mathematical, logic, shape, code, generate, generator, convert, converter
103 changes: 102 additions & 1 deletion assets/texts/en/amoDescription.html
Original file line number Diff line number Diff line change
@@ -1 +1,102 @@
export your Readme here, and potentially adjust it…
This is a (Firefox and Thunderbird) add-on (WebExtension) that allows you to autocorrect common text sequences and convert text characters to a look like a special font.
For instance, it converts quotes like <code>&quot;these&quot;</code> to <code>“these”</code>, which are typographically correct.
Additionally, you can convert text into more than 20 different font styles and casing changes.
You can enable and disable any features in the options and adjust more settings regarding the behavior of the add-on.


<b>😊 Convert text to any style you want! 😊</b>

Just select text, right-click and let Unicodify convert the text into styles like:
<ul>
<li>Lowercase</li>
<li>Uppercase</li>
<li>Capitalize Each Word</li>
<li>Toggle Case</li>
<li>Superscript</li>
<li>Small Caps</li>
<li>Unicase</li>
<li>Serif</li>
<li>Sans-serif</li>
<li>Bold</li>
<li>Italic</li>
<li>Script</li>
<li>Fraktur</li>
<li>Monospace</li>
<li>Double-struck</li>
<li>Circled</li>
<li>Squared</li>
<li>Fullwidth</li>
</ul>

This is useful on websites that do not support changing the font or text formatting.


<b>✍️ Improve your typographic style! ✍️</b>

When writing on any website, this add-on optionally corrects your writing by using proper quotation marks or common symbols like arrows, fractions or mathematical signs.

Some examples:
<ul>
<li><code>...</code> is corrected into <code></code></li>
<li><code>~=</code> is corrected into <code></code></li>
<li><code>+-</code> is corrected into <code>±</code></li>
<li><code>-+</code> is corrected into <code></code></li>
<li><code>&gt;=</code> is corrected into <code></code></li>
<li><code>1/4</code> is corrected into <code>¼</code></li>
<li><code>--></code> is corrected into <code></code></li>
<li><code>&lt;==&gt;</code> is corrected into <code></code></li>
<li>and much more…</li>
</ul>

<b>📢 More Features 📢</b>

<ul>
<li>Unicode autocorrection as you type:<ul>
<li>Autocorrect <a href="https://en.wikipedia.org/wiki/Miscellaneous_Symbols">Unicode symbols</a> (i.e. hyphens <code>--</code> with –, fractions <code>1/4</code> with ¼, etc.). Supports more
than 85 symbols.</li>
<li>Use Unicode smart quotes ('single quotes' with ‘Unicode single quotes’ and "double quotes" with “Unicode double quotes”)</li>
<li>Convert <a href="https://en.wikipedia.org/wiki/Number_Forms">fractions</a> and <a href="https://en.wikipedia.org/wiki/Mathematical_constant">mathematical constants</a> to Unicode characters (i.e. <code>1234.25</code>
with 1234¼, etc.). Supports all Unicode fraction characters, Pi and e constants.</li>
<li>Supports undoing autocorrections</li>
</ul>
</li>
<li>Context menu with selected/highlighted text:<ul>
<li><a href="https://en.wikipedia.org/wiki/Mathematical_Alphanumeric_Symbols">Unicode font</a> conversion (i.e. ꜱᴍᴀʟʟ ᴄᴀᴘꜱ, 𝒮𝒸𝓇𝒾𝓅𝓉, 𝔉𝔯𝔞𝔨𝔱𝔲𝔯, etc.). Supports more than 20 fonts.</li>
<li>Change <a href="https://en.wikipedia.org/wiki/Letter_case#Case_styles">casing</a> (i.e. UPPER CASE, lower case, tOGGLE cASE, etc.). Supports all locales.</li>
<li>Optionally show a live preview.</li>
</ul>
</li>
<li>Support websites as best as possible by providing website-specific possibles, if needed. (<a href="https://github.com/rugk/unicodify/issues">if there is a problem, please report it</a>)</li>
<li>Very fast, even when typing on large documents.</li>
<li>Supports the light/dark mode of your system automatically.</li>
<li>Settings automatically synced between all browser instances and devices (Firefox and Chrome only).</li>
<li>Follows the <a href="https://design.firefox.com/photon">Firefox</a> and <a href="https://style.thunderbird.net/">Thunderbird</a> Photon Design.</li>
<li>Puts your privacy first and does not send data anywhere.</li>
<li>Compatible with Firefox for Android.</li>
<li>Translated into several languages. <a href="https://github.com/rugk/unicodify/blob/main/CONTRIBUTING.md#Translations">Contribute your own language!</a></li>
<li>Settings can be managed by your administrator.</li>
</ul>



<b>📝 Development 📝</b>
The add-on is free/libre open-source software and developed on GitHub. <a href="https://github.com/rugk/unicodify">Fork it on GitHub</a> and contribute.
<a href="https://github.com/rugk/unicodify/contribute">There are some easy issues to start with.</a>

This extension works with modern Firefox and Thunderbird v78 or higher.


<b>🙋‍♀️ Contribute 🙋‍♀️</b>
You can easily get involved in this project and help. Here are some ideas:
<ul>
<li>📃 <a href="https://github.com/rugk/unicodify/blob/master/CONTRIBUTING.md#translations">Translate this add-on into multiple languages!</a></li>
<li>🐛 <a href="https://github.com/rugk/unicodify/blob/master/CONTRIBUTING.md#coding">Fix some easy issues and get started in add-on development</a> (or just try out the development version)</li>
<li>💡 <a href="https://github.com/rugk/unicodify/blob/master/CONTRIBUTING.md#need-ideas">Or check out some other add-on issues</a> (or translate them).</li>
</ul>
Or, in any case, <a href="https://github.com/rugk/unicodify/blob/master/CONTRIBUTING.md#support-us">support us by spreading the word!</a> ❤️



<b>💬 Permissions 💬</b>
This add-on requires as few permissions as possible.
An explanation of all permissions, this add-on requests, can be found <a href="https://github.com/rugk/unicodify/blob/master/assets/texts/en/permissions.md">on this site</a>.
2 changes: 1 addition & 1 deletion assets/texts/en/amoSummary.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
This add-on allows you to
Easily and quickly autocorrect common symbols as ¼ in text fields and transform text to “Unicode fonts” 𝐟𝐨𝐫 𝔢𝔵𝔞𝔪𝔭𝔩𝔢 𝚕𝚒𝚔𝚎 𝘵𝘩𝘪𝘴 as text characters and change the casing of texts.

0 comments on commit 8123e09

Please sign in to comment.