mirror of
https://github.com/GitJournal/GitJournal.git
synced 2025-06-27 01:02:14 +08:00
Update the docs to reflect that we're a Note taking app
We're moving away from focussing solely on Journaling. Lets update the README to reflect that.
This commit is contained in:
12
README.md
12
README.md
@ -14,16 +14,14 @@
|
|||||||
|
|
||||||
# Summary
|
# Summary
|
||||||
|
|
||||||
GitJournal is a journaling app built with privacy and openness in mind. It stores all its notes in a standardized Markdown + YAML header format. The notes are stored in a Git Repo of your choice - GitHub / Gitlab / Custom-provider.
|
GitJournal is a note taking app focused on privacy and data portability. It stores all its notes in a standardized Markdown + YAML header format. The notes are stored in a Git Repo of your choice - GitHub / Gitlab / Custom-provider. This means you can easily self host or host your notes in one of the many [Git providers](./docs/git_hosts.md).
|
||||||
|
|
||||||
Features -
|
Features -
|
||||||
|
|
||||||
- Private by design
|
- Can be used with any Git Repository
|
||||||
|
- Allows categorizing Notes based on Folders
|
||||||
- No Account Required
|
- No Account Required
|
||||||
- Open source
|
- Open source
|
||||||
- Can easily be extended and integrated with other git tools
|
|
||||||
- Git log clearly shows a history of changes
|
|
||||||
- Built for developers
|
|
||||||
|
|
||||||
# Screenshots
|
# Screenshots
|
||||||
|
|
||||||
@ -44,7 +42,9 @@ Features -
|
|||||||
|
|
||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
Development is tracked over [here](https://github.com/orgs/GitJournal/projects/1). Please feel free to open an issue for any bug or feature request. Additionally, you can vote on existing [Issues](https://github.com/GitJournal/GitJournal/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) by reacting with a '👍'.
|
Development is tracked over [here](https://github.com/orgs/GitJournal/projects/1).
|
||||||
|
|
||||||
|
Please feel free to [open an issue](https://github.com/GitJournal/GitJournal/issues/new) for any bug or feature request. Additionally, you can vote on existing [Issues](https://github.com/GitJournal/GitJournal/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) by reacting with a '👍'.
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
||||||
|
23
docs/git_hosts.md
Normal file
23
docs/git_hosts.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
# List of Git Hosts
|
||||||
|
|
||||||
|
Git Providers -
|
||||||
|
* GitHub
|
||||||
|
* GitLab.org
|
||||||
|
* BitBucket
|
||||||
|
* SourceForge
|
||||||
|
* Launchpad
|
||||||
|
* BeanStalkApp
|
||||||
|
* Google Cloud Source Repositories
|
||||||
|
* AWS Code Commit
|
||||||
|
|
||||||
|
Self Hosting -
|
||||||
|
* Plain SSH
|
||||||
|
* Gitea
|
||||||
|
* Gogs
|
||||||
|
* GitLab
|
||||||
|
* Gitolite
|
||||||
|
* Apache Allura
|
||||||
|
* Kallithea
|
||||||
|
* Phabricator
|
||||||
|
* GitBucket
|
||||||
|
* GitPrep
|
Reference in New Issue
Block a user