|
@@ -43,18 +43,31 @@ $ lorca
|
|
|
## System Requirements
|
|
|
|
|
|
- *nix OS.
|
|
|
+- xsel or xclip (linux)
|
|
|
- Ruby 2.4+
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
+### CLI
|
|
|
+
|
|
|
To use Lorca as a command line interface:
|
|
|
|
|
|
-```bash
|
|
|
-$ gem install lorca
|
|
|
+```terminal
|
|
|
+$ gem fetch lorca -v <version>
|
|
|
+$ ruby -rdigest/sha2 -e "puts Digest::SHA512.new.hexdigest(File.read('lorca-<version>.gem'))"
|
|
|
+```
|
|
|
+
|
|
|
+Compare it with the hash in `checksum/lorca-<version>.gem.sha512` to
|
|
|
+verify the integrity of the fetched gem. If the checksum matches
|
|
|
+
|
|
|
+```terminal
|
|
|
+$ gem install lorca -v <version>
|
|
|
```
|
|
|
|
|
|
-If you want to use Lorca as a gem add it to the project's Gemfile:
|
|
|
+### Gem
|
|
|
+
|
|
|
+To use Lorca as a gem add it to the project's Gemfile:
|
|
|
|
|
|
```ruby
|
|
|
gem "lorca"
|
|
@@ -63,7 +76,7 @@ gem "lorca"
|
|
|
And then run
|
|
|
|
|
|
```bash
|
|
|
-$ bundle
|
|
|
+$ bundle install
|
|
|
```
|
|
|
|
|
|
For details on the API check out the [online documentation](https://_rem.gitlab.io/lorca).
|
|
@@ -76,20 +89,28 @@ Whenever there's a new release available read the
|
|
|
[ChangeLog.md](https://_rem.gitlab.io/lorca/files/ChangeLog_md.html)
|
|
|
for details on what changed since the last release.
|
|
|
|
|
|
-When you are ready to update, depending on the installation method, do:
|
|
|
+#### CLI
|
|
|
+
|
|
|
+Fetch and verify gem, as above,
|
|
|
+
|
|
|
+```terminal
|
|
|
+$ gem fetch lorca -v <version>
|
|
|
+$ ruby -rdigest/sha2 -e "puts Digest::SHA512.new.hexdigest(File.read('lorca-<version>.gem'))"
|
|
|
+```
|
|
|
+
|
|
|
+then
|
|
|
|
|
|
```bash
|
|
|
$ gem update lorca
|
|
|
$ gem cleanup lorca
|
|
|
```
|
|
|
|
|
|
-or, as a gem
|
|
|
+#### Gem
|
|
|
|
|
|
```bash
|
|
|
$ bundle update lorca
|
|
|
```
|
|
|
|
|
|
-
|
|
|
## License
|
|
|
|
|
|
Copyright (c) 2018-2019, René Maya. Licensed ISC. Read attached
|