Commit graph

62 commits

Author SHA1 Message Date
Micah Jerome Ellison
5b029e6117
Documentation updates (#1032)
* Applying doc changes based on reviews of past several documentation PRs
* Update docs
  Clean up encryption docs
  Clean up security docs
  Delete export.md
  Make new formats.md and add to sidebar. Also add all of the built-in formats, and examples for each.
  Update mkdocs config for new files

* Fix broken docs links
* Correct incomplete sentences and markdown formatting issues
* Make overview a little more concise
* Update some command line arguments to latest version and make it a bit more concise
* Clean up unneeded TOML modifications and other scaffolding not needed for 3.9
* Revert "Clean up unneeded TOML modifications and other scaffolding not needed for 3.9"
  This reverts commit 13b4266ed1.
* Specify that brew is also the easiest way to install jrnl on Linux
* Update docs/security.md
* Update docs/recipes.md
* Doc updates:
- Remove import/export page, fold it into formats
- Rename security to privacy-and-security.md to avoid conflation w/ github security issues
- Various small cleanup and edits from PR review

Co-authored-by: Jonathan Wren <jonathan@nowandwren.com>
2020-10-24 15:41:58 -07:00
Jonathan Wren
29234ddc35
Documentation updates (Thanks @guydebros!) (#1031)
* updated README.md:

- corrected information about encryption
- made additions based on proposed changes to overview.md
- made other changes for clarity and grammar

* ongoing changes to overview.md

* added note that `pycrypto` is required

made other small changes for grammar and clarity

* added new python decryption script to encryption.md

* updated encryption.md to clarify dependencies

other relatively small changes for clarity

straightened quotes

Co-authored-by: Guy B. deBros <guydebros@users.noreply.github.com>
2020-08-22 12:13:36 -07:00
Jonathan Wren
6abee8e9d6 fix readme link to submit an issue (#1002) 2020-07-18 12:08:34 -07:00
Jonathan Wren
919ab7902d Rename master branch to release (#985)
It's not our main branch anyway, and "release" makes it more clear what
it's for. There's an industry-wide trend to move away from terms that
invoke master/slave relationships in order to make members of
marginalized populations slightly less uncomfortable.
2020-06-20 14:11:03 -07:00
Jonathan Wren
fc2b49fbd3 Clean up readme file (#924) 2020-04-25 13:15:55 -07:00
jess
6198604045 Add Open Collective information to README (#916)
* Added financial contributors to the README
2020-04-18 12:35:46 -07:00
Manuel Ebert
328faa401c Smaller doc fixes, fixes #486
Found and removed another angsty teenager
2020-04-10 11:51:55 -07:00
Micah Jerome Ellison
57f6f2c3d7 [GH-605] pointing to a more comprehensive GitHub issue re DayOne 2020-04-10 11:51:55 -07:00
Micah Jerome Ellison
20e0daadf5 [GH-605] mentioning lack of Day One support and relevant history in readme 2020-04-10 11:51:55 -07:00
Micah Jerome Ellison
e563a94456 [GH-600] updating Travis build badge and restoring pypi badges 2020-04-10 11:51:55 -07:00
Micah Jerome Ellison
1e0920eff0 [GH-598] Changing references from jrnl-plus back to jrnl and ensuring the URLs are valid (except build badge) 2020-04-10 11:51:55 -07:00
Micah Jerome Ellison
38b1bcbc4d [GH-1] updating readme to mention fork, instability
[GH-1] adding build badge back in
[GH-1] fussing with author text
2020-04-10 11:51:55 -07:00
Jonathan Wren
d3b7819bc1 [GH-3] update build badges 2020-04-10 11:51:55 -07:00
Manuel Ebert
b1398dc9b2 Update README.md 2014-06-05 16:01:18 +02:00
Manuel Ebert
48a6e03183 Update README.md 2014-06-05 16:01:07 +02:00
Manuel Ebert
c882e4da28 Update README.md 2014-06-05 15:59:12 +02:00
Manuel Ebert
d8f3b7a9be Download count 2014-02-05 12:21:27 -08:00
Manuel Ebert
3ee749c26c Glorious. 2013-11-05 10:21:46 -08:00
Manuel Ebert
e81e388696 Updates readme 2013-10-20 13:30:45 -07:00
Bitdeli Chef
f3e6ea14cb Add a Bitdeli badge to README 2013-10-08 17:57:54 +00:00
Manuel Ebert
c88f7fe690 Version bump and doc fixes 2013-08-17 12:09:57 -07:00
Manuel Ebert
857583953e Readme + changelog update 2013-08-14 14:08:05 -07:00
Manuel Ebert
da261e9614 Links for getting help 2013-07-24 15:03:54 -07:00
Manuel Ebert
d22451e295 Updated Readme 2013-07-17 18:24:53 +02:00
Aniket Pant
ae01072197 Update readme in accordance to changes
Signed-off-by: Aniket Pant <me@aniketpant.com>
2013-06-26 13:05:24 +05:30
Aniket Pant
3207dd10aa Update readme
Information on new export options added

Signed-off-by: Aniket Pant <me@aniketpant.com>
2013-06-21 19:23:27 +05:30
Manuel Ebert
e94755d556 Typo 2013-06-09 15:59:49 -07:00
Manuel Ebert
3c07c7dee0 pycrypto back to extras.
Fixes 68
2013-04-22 09:58:45 +02:00
Manuel Ebert
cb77ebc81b Build status 2013-04-19 17:58:07 +02:00
Manuel Ebert
8842b8589f Updated readme and changelog and changed config path according to discussion 2013-04-19 16:58:19 +02:00
Manuel Ebert
a8958e7b0d Automatic versioning 2013-04-17 10:19:38 +02:00
Manuel Ebert
ba6f7a43ba Makes PyCrypto an automatic install 2013-04-17 10:19:25 +02:00
Manuel Ebert
e0f7d235b1 Uses colorama instead of clint 2013-04-17 10:19:02 +02:00
Manuel Ebert
165d9b2d8d Fixes typos in readme 2013-03-13 00:51:24 -07:00
Manuel Ebert
fb8bc90eac Documentation on DayOne integration 2012-08-09 18:43:57 +02:00
Manuel Ebert
d6efe2def3 Notes on individual settings for multiple journals 2012-07-23 13:09:45 +02:00
Manuel Ebert
5b1854122c Formatting issues. 2012-06-20 20:57:12 +03:00
Manuel Ebert
61865a88b9 Help on multiple journals. 2012-06-11 16:16:26 +02:00
Manuel Ebert
2944fc85e8 Linewrap support documented 2012-05-30 17:45:52 +02:00
Manuel Ebert
5032adef61 removed necessity to create bash alias 2012-05-24 13:28:50 +02:00
Manuel Ebert
a65e5eac50 Added note for Windows users, closes #29 2012-05-22 17:36:47 +03:00
Manuel Ebert
94f0a9b7ab License, readme and changelog renamed 2012-05-21 12:25:54 +02:00
Manuel Ebert
dd66314b3d License, readme and changelog renamed 2012-05-21 12:25:02 +02:00
Manuel Ebert
62d4b10cc4 Added readme on -short option 2012-05-03 14:27:24 +03:00
Manuel Ebert
526ee009e8 Adds support for tag highlighting as proposed by #16 2012-04-24 18:44:57 +02:00
Manuel Ebert
eab92dbb23 Adds tag search, closes #16 2012-04-24 12:05:17 +02:00
Manuel Ebert
87d4858abd Notes on --encrypt and --decrypt 2012-04-17 21:54:08 +02:00
Stephan Gabler
a8a7fb2944 add markdown support to the readme, close #8 2012-04-17 21:46:18 +02:00
Manuel Ebert
b286bf9af7 Details on AES encryption 2012-04-17 00:06:04 +02:00
Manuel Ebert
2ebf976653 Fixes a mistake in the advanced cryptography explanation. 2012-04-16 23:31:40 +03:00