Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Keppler2020-04-14 01:35:53 -0400
committerMichael Keppler2020-04-14 01:35:53 -0400
commit33722a3b5e27879e2ed049a2f502ae18b98f2163 (patch)
tree92071a012fd0274a5117967ce3b286ba96941ae0
parentf35bc2393d574d0c59f3c90b6f63d00612ce1920 (diff)
downloadegit-github-33722a3b5e27879e2ed049a2f502ae18b98f2163.tar.gz
egit-github-33722a3b5e27879e2ed049a2f502ae18b98f2163.tar.xz
egit-github-33722a3b5e27879e2ed049a2f502ae18b98f2163.zip
Improve README
Improve text and links to be more similar to egit README. This file is displayed both in the eclipse.org gitile browser as well as on github.com when browsing to the repository. Change-Id: If3816ad2a13fc9a7601a8dda2f93abaea179a9a7 Signed-off-by: Michael Keppler <Michael.Keppler@gmx.de>
-rw-r--r--README.md36
1 files changed, 13 insertions, 23 deletions
diff --git a/README.md b/README.md
index 28bfd9a0..9086efa6 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,13 @@
-Eclipse EGit Github Connector
-=============================
+# Eclipse EGit Github Connector
-EGit Github Connector is an Eclipse plugin for working with Git repositories
-hosted on Github. It is based on the JGit library, which is a Git implementation
+_EGit Github Connector_ is an Eclipse plugin for working with Git repositories
+hosted on Github. It is based on the _JGit_ library, which is a Git implementation
in pure Java and integrates with EGit which is the Eclipse Git Team Provider.
-This package is licensed under the EPL. Please refer to the LICENSE file
+This package is licensed under the _EPL 2.0_. Please refer to the `LICENSE` file
for the complete license.
-Compatibility
--------------
+## Compatibility
- In general, EGit supports at least the latest two Eclipse releases.
For details, please see https://wiki.eclipse.org/EGit/FAQ
@@ -18,35 +16,27 @@ Compatibility
existing functions and change others without other notice than what
is written in the commit log and source files themselves.
-Support
--------
+## Support
-Post question or comments to the egit-dev@eclipse.org mailing list.
-You need to be subscribed to post, see here:
-
-https://dev.eclipse.org/mailman/listinfo/egit-dev
+Post questions or comments to the egit-dev@eclipse.org mailing list.
+You need to be [subscribed](https://dev.eclipse.org/mailman/listinfo/egit-dev)
+to post.
Bugs are tracked in [Bugzilla](https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&classification=Technology&component=GitHub&list_id=11227256&product=EGit&query_format=advanced)
Create new bugs [here](https://bugs.eclipse.org/bugs/enter_bug.cgi?product=EGit;component=GitHub)
-Contributing
-------------
+## Contributing
**This project does not use pull requests.**
Pull requests to this GitHub repository will be ignored.
Push patches to Gerrit at https://git.eclipse.org/r/egit/egit-github as explained
-in the Contributor Guide:
-
-https://wiki.eclipse.org/EGit/GitHub/ContributorGuide
+in the [EGit Contributor Guide](https://wiki.eclipse.org/EGit/Contributor_Guide).
-About Git
----------
+## About Git
More information about Git, its repository format, and the canonical
-C based implementation can be obtained from the Git websites:
-
-http://git-scm.com/
+C based implementation can be obtained from the [Git website](https://git-scm.com/).

Back to the top