-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add a get started documentation
- Loading branch information
Showing
2 changed files
with
30 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
========================= | ||
Getting Started | ||
========================= | ||
|
||
Welcome to the **comeit** project! A linter for conventional commits. Follow the steps below to | ||
install and start using the package. | ||
|
||
1. **Install the package**: | ||
|
||
You can install **comeit** directly from PyPI using `pip`: | ||
|
||
.. code-block:: bash | ||
pip install comeit | ||
2. **Run the application** | ||
|
||
**comeit** includes a CLI tool, you can run it like this: | ||
|
||
.. code-block:: bash | ||
comeit | ||
By default, ``comeit`` uses ``git`` internally with ``gitpython`` to read all the commits on the | ||
current branch. These are the commits that are parsed and reported if nothing else is specified. | ||
|
||
|
||
You're ready to go! Explore the project documentation for further details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters