Skip to content

Commit fefab41

Browse files
committed
chore(docs): Release 2.1.0
1 parent 5c886dc commit fefab41

File tree

2 files changed

+13
-26
lines changed

2 files changed

+13
-26
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and
66
this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## [2.1.0] - 2024-04-03
99

1010
### Added
1111

README.md

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@
99
Makes command `sdk` from [SDKMAN!] usable from [fish], including auto-completion.
1010
Also adds binaries from installed SDKs to the PATH.
1111

12-
Version 2.0.0 has been tested with
12+
Version 2.1.0 has been tested with
1313

14-
- fish 3.6.1, and
15-
- SDKMAN! 5.18.2, on
16-
- Ubuntu 22.04 LTS and macOS 12.6
14+
- fish 3.7 and
15+
- SDKMAN! 5.18.2 on
16+
- Ubuntu 22.04 LTS and macOS 14.4
1717

1818
## Install
1919

2020
With [fisher] (install separately):
2121

2222
```
23-
fisher install reitzig/sdkman-for-fish@v2.0.0
23+
fisher install reitzig/sdkman-for-fish@v2.1.0
2424
```
2525

2626
_Note:_
@@ -39,27 +39,25 @@ _Note:_
3939
for example, you can use `.config/fish/conf.d/config_sdk.fish`.
4040
- If _both_ are set, `__sdkman_custom_dir` is used.
4141
42-
4342
## Usage
4443
45-
It's all in the background; you should be able to run `sdk` and binaries installed
46-
with `sdk` as you would expect.
47-
44+
It's all in the background; you should be able to run `sdk` and
45+
binaries installed with `sdk` as you would expect.
4846
4947
## Contribute
5048
51-
When you make changes,
49+
When you propose changes,
5250
please run the tests at least on one platform before creating a pull request.
5351
54-
As the tests may mess up your own setup
52+
As the tests may mess up your machine
5553
-- you have been warned! --
56-
the recommended way is to run the tests in a Docker container:
57-
54+
the recommended way is to run them in a Docker container:
55+
5856
```fish
5957
docker build -t sdkman-for-fish-tests -f test/Dockerfile .
6058
docker run --rm -it sdkman-for-fish-tests
6159
```
62-
60+
6361
A run configuration for Jetbrains IDEs is included.
6462

6563
It is a also possible to run individual features, for instance:
@@ -68,17 +66,6 @@ It is a also possible to run individual features, for instance:
6866
docker run --rm sdkman-for-fish-tests features/completions.feature
6967
```
7068

71-
As a corollary, this is the fastest way to run all tests
72-
(if you do not care about the report):
73-
74-
```fish
75-
for f in features/*.feature
76-
docker run --rm sdkman-for-fish-tests "$f" &
77-
done
78-
wait
79-
```
80-
81-
8269
## Acknowledgements
8370

8471
* Completion originally by [Ted Wise](https://github.com/ctwise); see his

0 commit comments

Comments
 (0)