changing API

This commit is contained in:
Fakerr 2017-01-28 20:53:23 +01:00
parent a07ed49138
commit 624c5b3496
3 changed files with 21 additions and 21 deletions

View file

@ -1,7 +1,7 @@
PREFIX = /usr/local
BINPREFIX = "$(PREFIX)/bin"
LIB=git-hlog
LIB=git-recall
.PHONY: all install uninstall

View file

@ -1,16 +1,16 @@
# log-so-handy
# git-recall
> A simple and convenient Git tool to easily check your commits.
![git hlog](http://imgur.com/bq9kRez.gif)
![git recall](http://imgur.com/bq9kRez.gif)
## Usage
```sh
$ git hlog [-a <author name>]
[-d <days-ago>]
[-f]
[-h]
$ git recall [-a <author name>]
[-d <days-ago>]
[-f]
[-h]
```
##### Options description:
@ -34,23 +34,23 @@ You can still use either `TAB` or `q` to return to the commits list.
## Examples
```sh
$ git hlog
$ git recall
# By default (without options), the command will display commits from yesterday and
# for the current user.
```
```sh
$ git hlog -d 5 -a "Doge"
$ git recall -d 5 -a "Doge"
# The command will show all Doge's commits from 5 days ago.
$ git hlog -d 5 -a "all"
$ git recall -d 5 -a "all"
# The command will show commits of all contributors from 5 days ago.
```
```sh
$ git hlog -f
$ git recall -f
# Fetch commits beforehand.
```
@ -59,7 +59,7 @@ $ git hlog -f
##### Without using tools
```
You can install it by simply copying the `git-hlog` script into any existing path
You can install it by simply copying the `git-recall` script into any existing path
(e.g. /usr/local/bin) or create your own directory and add it to the 'PATH' variable.
```
@ -67,14 +67,14 @@ You can install it by simply copying the `git-hlog` script into any existing pat
Use `npm` to install the project.
```sh
npm install --global log-so-handy
npm install --global git-recall
```
##### Manual install
Clone the project and install it using make install.
```sh
$ git clone https://github.com/Fakerr/log-so-handy.git
$ cd log-so-handy
$ git clone https://github.com/Fakerr/git-recall.git
$ cd git-recall
$ sudo make install
```
## Requirements

View file

@ -1,17 +1,17 @@
{
"name": "log-so-handy",
"version": "1.0.3",
"description": "Convenient log for git",
"name": "git-recall",
"version": "1.1.0",
"description": "Simple and convenient Git tool to easily recall what you've done",
"main": "",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "https://github.com/Fakerr/log-so-handy.git"
"url": "https://github.com/Fakerr/git-recall.git"
},
"bin": {
"git-hlog": "./git-hlog"
"git-recall": "./git-recall"
},
"keywords": [
"git",
@ -20,5 +20,5 @@
],
"author": "Walid Berrahal",
"license": "MIT",
"homepage": "https://github.com/Fakerr/log-so-handy"
"homepage": "https://github.com/Fakerr/git-recall"
}