Skip to content

Commit 88f11c7

Browse files
authored
Update the README with a better description of current features
1 parent 49c23e1 commit 88f11c7

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,30 @@ Xit (pronounced "exit") is a graphical tool for working with git repositories. T
1212

1313
Xit began as a rewrite of GitX, born from a desire for a codebase that was easier to work with, thoroughly unit tested, etc. It is currently in beta, where most basic features are in place. You can check the GitHub issues and milestones to see what is planned.
1414

15-
# Roadmap
15+
# Features
16+
17+
* **Sidebar** showing branches, remotes, tags, submodules, and stashes.
18+
* If you sign in with your TeamCity account, you can see build status for branches you have pushed.
19+
* If you sign in with your Bitbucket Server account, you can see and act on pull requests.
20+
* Support for more services, such as GitHub, is in the works.
21+
* **History list** with a graph of commits and branches.
22+
* Search the list by author, message content, or hash.
23+
* Navigate backwards and forwards through your history of selected commits.
24+
* **File lists and previews** for workspace files and previous commits.
25+
* See just the files that changed, or use the outline view to browse the whole hierarchy at any commit.
26+
* Preview files as diffs, blame, plain text, or QuickLook.
27+
* Blame view has color coding to show lines that changed at the same time, and links back to the commit they came from.
1628

17-
The plan is to have a concrete 1.0 milestone to provide a good foundation and firm direction moving forward. Version 1.0 will simply be a starting point covering basic usage:
29+
# Roadmap
1830

19-
* History view graph
20-
* Sidebar for navigating branches, remotes, tags, and stashes
21-
* Viewing the diff of a selected commit
22-
* Basic git actions: staging, committing, remote push/pull
23-
* A few fun extras that I wanted to fit in along the way (like TeamCity build status)
31+
The plan is to have a concrete 1.0 milestone to provide a good foundation and firm direction moving forward. Version 1.0 will simply be a starting point covering basic usage, plus some fun extras like the beginnigs of online service integration.
2432

2533
Plenty of advancements are on the post-1.0 list, like syntax highlighting and other diff view enhancements, file history, etc.
2634

2735
Some other ideas that I’m looking forward to working on (and using!):
2836

29-
* Interacting with git hosting services (especially GitHub): discovering forks, viewing commits online, working with pull requests
37+
* More robust push and pull, and better handling of merge conflicts
38+
* Interacting more with git hosting services (especially GitHub): discovering forks, viewing commits online, working with pull requests
3039
* Interactive rebase
3140
* Explore more ways to navigate and visualize the repository
3241

0 commit comments

Comments
 (0)