Skip to content

Commit 07ba31b

Browse files
committed
docs changes for 1.8
1 parent 71a1f96 commit 07ba31b

File tree

5 files changed

+32
-19
lines changed

5 files changed

+32
-19
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ works with the Yubikey 5 NFC, Yubikey 4 and the Yubikey NEO.
3333
- Import text files as notes directly into your working notebook
3434
- Switch between notebooks easily
3535
- Multiple notebooks support. Easily add, rename, copy and delete notebooks
36-
36+
- Bash Completion for sub commands and note/notebook names
3737

3838
## Licence
3939

RELEASE-NOTES.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
# RELEASE NOTES
44

5-
1.5 SECOND RELEASE
5+
1.8
6+
- Added Bash completion
7+
- fixes for SHA256 creation for FreeBSD sha256
8+
vs Linux sha256sum commands
9+
- A number of documentation corrections
10+
11+
1.6
612
- Fully expanded README.md giving base documentation
713
- Search functionality added
814
- Updated project documentation to markdown (excluding

ROADMAP.md

+17-12
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,20 @@
33
44
ROADMAP
55

6-
1.5 EXPANDED FEATURES INCLUDING SEARCH
7-
- Search through encrypted notes with grep (#19)
8-
- Expanded documentation
6+
1.8 BASH COMPLETION and other changes
7+
- Bash completion added for sub commands and note/notebook names
8+
- Documentation changes
9+
- Fixes for 'make tarball' to handle differences between Linux
10+
sha256sum(1) and FreeBSD sha256(1) commands
11+
12+
1.6 EXPANDED FEATURES INCLUDING SEARCH
13+
- Search through encrypted notes with grep (#19)
14+
- Expanded documentation
915
- Added undocumented 'tree' subcommand for paging through
10-
the notes directory (#20)
16+
the notes directory (#20)
1117
- Support for $NOTESDIR to override data store location (#16)
12-
- Support for $XDG_DATA_DIR/.notes to store data (#15)
13-
- Fixed bug with spaces in filenames (#2)
18+
- Support for $XDG_DATA_DIR/.notes to store data (#15)
19+
- Fixed bug with spaces in filenames (#2)
1420

1521
1.0 INITIAL RELEASE
1622
- GPG encrypted notes
@@ -19,7 +25,7 @@
1925
- add/delete/rename notebooks
2026
- re-encrypt with new GPG key
2127
- packaged as a tarball with SHA256 (#14)
22-
- packaged as a .deb (#11)
28+
- packaged as a .deb (#11)
2329

2430
IN NEXT RELEASE (IMPLEMENTED)
2531

@@ -29,11 +35,10 @@ FUTURE FEATURES
2935
- multiuser encryption
3036
- different gpg keys per notebook
3137
- git integration
32-
- bash completion
3338
- zsh completion
3439
- FreeBSD .PKG packaging
3540
- FreeBSD ports configuration
36-
- shred functionality
37-
- encrypted backup/restore
38-
- PIV card support
39-
- Issue #17 BUG - import truncates filename if spaces in filename
41+
- shred functionality
42+
- encrypted backup/restore
43+
- PIV card support
44+
- Issue #17 BUG - import truncates filename if spaces in filename

SECURITY.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ We support the following versions of this application:
66

77
| Version | Supported |
88
| ------- | ------------------ |
9-
| 1.5 | :white_check_mark: |
9+
| 1.8 | :white_check_mark: |
10+
| 1.6 | :white_check_mark: |
1011
| 1.0 | :white_check_mark: |
1112

1213

@@ -19,10 +20,6 @@ to fork and create a pull-request.
1920

2021
## Expectations and Version
2122

22-
Each release will be released with a nn.0 tag. Vulnerabilities fixes
23-
will be fixed and released as a nn.x where x is incremented
24-
sequentially with each patch to the 'nn' release.
25-
2623
We do not release fixes for prior versions. Fixes for bugs and
2724
vulnerabilities will be added to the working version at HEAD and a nn.x
2825
version released.

docs/notes.1

+5
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,11 @@ KEYID of the private key you wish to use.
5050
keys, then run \fBnotes newkey <keyid>\fP. Notes will replace the keyid automatically in the
5151
config file.
5252

53+
.SH SHELL INTEGRATION
54+
55+
From version 1.8 onwards Notes/Notebook support Bash completion for sub
56+
commands and note/notebook filenames.
57+
5358
.SH COMMANDS
5459

5560
The notes program takes a set of commands that allows the user to manipulate the

0 commit comments

Comments
 (0)