PHPackages                             square1/gwitlog - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. square1/gwitlog

ActiveLibrary[Utility & Helpers](/categories/utility)

square1/gwitlog
===============

Make developers eager to read your commit log by styling it like a social media timeline

0.1.5(11y ago)126MITPHPPHP >=5.3.0

Since Sep 23Pushed 11y ago3 watchersCompare

[ Source](https://github.com/square1-io/gwitlog)[ Packagist](https://packagist.org/packages/square1/gwitlog)[ RSS](/packages/square1-gwitlog/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (1)Versions (7)Used By (0)

Gwitlog
=======

[](#gwitlog)

Make developers eager to read your commit log by styling it like a social media timeline.

Based on this [commitstrip comic](http://www.commitstrip.com/en/2014/08/07/our-cto-has-discovered-an-incredible-way-of-making-developers-read-his-commit-messages-you-wont-even-believe-how-he-did-it/), this tool allows you to take a commit log from a git repo and style it to look like a social media timeline.

### Installation

[](#installation)

The package can be installed by adding the "conroyp/gwitlog": "dev-master" package to your project's `composer.json`.

```
[
    "require": {
        "square1/gwitlog": "0.1.*"
    }
]
```

### Usage

[](#usage)

#### Generating the log file

[](#generating-the-log-file)

The required format of the git log is generated by running the below command on your repository:

`git log --pretty=format:'%H -%d %s (%ad) '`

#### Outputting the timeline to screen

[](#outputting-the-timeline-to-screen)

```