diff --git a/README.md b/README.md index aed9a66..4ee01ec 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,43 @@ The main goal of Gitnuro is to provide a multiplatform open source Git client wi The project it is still in alpha and many feature are lacking or missing, but it's somewhat usable for basic usage. +Right now you CAN: + +- View diffs for text based files. +- View your history log and all its branches. +- Add (stage) & reset (unstage) files. +- Stage & unstage of hunks. +- Checkout files (revert changes of uncommited files). +- Clone. +- Commit. +- Reset commits. +- Revert commits. +- Merge commits (still lacking). +- Create and delete branches locally. +- Create and delete tags locally. +- View remote branches. +- Pull and push. +- Stash and pop stash. +- Checkout a commit (detached HEAD). + +Right now you CAN'T: + +- Rebase. +- Rebase interactive. +- Manage remotes. +- Remove branches from remote. +- Remove tags from remote. +- Force push. +- View changes/diff in images (side to side comparison). +- Side by side diff in text files. +- Start a new local repository. +- View stashes in the log tree. +- Multiple customization settings. + + Feel free to open issues for bugs or sugestions. + +## Screenshots (latest update: 04 jan 2021) +![Example 1](/res/img/gitnuro_example_1.png) +![Example 2](/res/img/gitnuro_example_2.png) +![Example 3](/res/img/gitnuro_example_3.png) \ No newline at end of file diff --git a/res/img/gitnuro_example_1.png b/res/img/gitnuro_example_1.png new file mode 100644 index 0000000..4664a34 Binary files /dev/null and b/res/img/gitnuro_example_1.png differ diff --git a/res/img/gitnuro_example_2.png b/res/img/gitnuro_example_2.png new file mode 100644 index 0000000..667bcac Binary files /dev/null and b/res/img/gitnuro_example_2.png differ diff --git a/res/img/gitnuro_example_3.png b/res/img/gitnuro_example_3.png new file mode 100644 index 0000000..2fc2e56 Binary files /dev/null and b/res/img/gitnuro_example_3.png differ