# The Neocities Gem

A CLI and library for using the Neocities API. Makes it easy to quickly upload, push, delete, and list your Neocities site.

## Installation

### Mac OSX

If you're using OSX (or already have ruby installed):

    gem install neocities

### Ubuntu/Debian

    sudo apt-get install ruby

### Windows

Install ruby with [RubyInstaller](https://rubyinstaller.org/). Then you can install the gem with the above command.

### Running

After that, you are all set! Run `neocities` in a command line to see the options and get started.

## Neocities::Client

This gem also ships with Neocities::Client, which you can use to write code that interfaces with the Neocities API.
