Merge branch 'dev-0.1.1' into release-0.1

GHTaarn · Mar 10, 2024 · 6bd0c41 · 6bd0c41 · GHTaarn · Mar 10, 2024
2 parents 1de6d7c + 3a27ac5
commit 6bd0c41
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 8 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "UnicodeREPL"
 uuid = "386912cb-a936-462a-a347-7bd6cef0b04e"
 authors = ["GHTaarn <[email protected]>"]
-version = "0.1.0"
+version = "0.1.1"
 
 [deps]
 REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"

diff --git a/README.md b/README.md
@@ -1,16 +1,22 @@
 # UnicodeREPL
 
 This is a small [Julia](https://julialang.org) package that enables the user
-to obtain any Unicode character (that the system fonts can display) in the
-Julia REPL if the [Unicode codepoint](https://codepoints.net) is known.
+to obtain any Unicode character in the Julia REPL if the
+[Unicode codepoint](https://codepoints.net) is known (and if the system fonts
+can display it).
 
 ## Installation
 
 In the Julia REPL type:
 ```julia
 import Pkg
-Pkg.add("https://github.com/GHTaarn/UnicodeREPL.jl")
+Pkg.add("UnicodeREPL")
 ```
+(Because `UnicodeREPL.jl` uses non-public Julia interface components,
+the official version is only compatible with stable Julia versions.
+You can bypass this check with
+`Pkg.add("https://github.com/GHTaarn/UnicodeREPL.jl#nocompat")` if you are
+using an unstable version of Julia)
 
 ## Use
 
@@ -19,9 +25,13 @@ In the Julia REPL type:
 using UnicodeREPL
 ```
 
-Hereafter, you will be able to enter "unicode repl" mode by typing
+Herafter you can use the docstring (by typing `?UnicodeREPL`) to get a
+quick overview of how to use UnicodeREPL.
+
+The main feature is "unicode repl" mode, which can be entered by typing
 the `^` character at the start of a line.
-In "unicode repl" mode, any pattern matching `\u(XXXX)` will be
+When the `Tab` key is pressed in "unicode repl" mode, patterns matching
+`\u(XXXX)` will be
 converted to the Unicode character corresponding to `XXXX`, where `XXXX` is a
 string of any length containing the hexadecimal
 [Unicode codepoint](https://codepoints.net) of a valid Unicode character.

diff --git a/src/UnicodeREPL.jl b/src/UnicodeREPL.jl
@@ -3,8 +3,8 @@
 
 On an empty line, press ^ to enter unicode_repl mode and backspace to exit.
 
-In unicode_repl mode, `\\u(XXXX)` tab completes to the symbol at Unicode
-codepage `XXXX` where `XXXX` is a hexadecimal string of any length.
+In unicode_repl mode, `\\u(XXXX)` tab completes to the symbol with Unicode
+codepoint `XXXX` where `XXXX` is a hexadecimal string of any length.
 
 ## Exported Symbols