Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/emcrisostomo/github-api-client

GitHub API Client for the UNIX shell
https://github.com/emcrisostomo/github-api-client

api client github library shell unix

Last synced: about 2 months ago
JSON representation

GitHub API Client for the UNIX shell

Awesome Lists containing this project

README

        

[![License](https://img.shields.io/badge/license-GPL--3.0-blue.svg?style=flat)](https://github.com/emcrisostomo/github-api-client/blob/master/LICENSE)

github-api-client
=================

`github-api-client` is a GitHub API client for the UNIX shell.

Prerequisites
-------------

`github-api-client` requires the following programs to be present on the `${PATH}`:

* `curl`
* `jq`
* `zsh`

Getting github-api-client
-------------------------

A user who whishes to build this package should get a [release
tarball][release]. A release tarball contains everything a user needs to build
the package on his system, following the instructions detailed in the
Installation section below and the `INSTALL` file.

A developer who wishes to modify this package should get the sources (either
from a source tarball or cloning the repository) and have the GNU Build System
installed on his machine. Please read `README.gnu-build-system` to get further
details about how to bootstrap this package from sources on your machine.

Getting a copy of the source repository is not recommended unless you are a
developer, you have the GNU Build System installed on your machine, and you know
how to bootstrap it on the sources.

[release]: https://github.com/emcrisostomo/github-api-client/releases

Installation
------------

See the `INSTALL` file for detailed information about how to configure and
install this package.

Usage
-----

To do.

Bug Reports
-----------

Bug reports can be sent directly to the authors.

-----

Copyright (c) 2018 Enrico M. Crisostomo

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 3, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program. If not, see .