ocelotpkg v0.1.1

Installing Ocelot

The most modern and secure distributions of Ocelot are distributed via NPM. To install Ocelot in your machine, run:

$ npm install -g ocelotpkg

Installing and publishing modules with Ocelot

Ocelot doesn't have a public registry where packages are compressed and stored online. Instead, it only gets them from GitHub.

Installing

$ ocelot install author/package:branch

It's very important that you serve this information correctly in the specified format, either Ocelot will return an error and the package won't be installed.

Publishing

As explained before, Ocelot gets packages from an external GitHub repository, so you will have to upload your project to GitHub. Make sure to use the ocelot init command to create an ocelot.toml file. This file will define important info about your package.

You can also add Ocelot dependencies adding their GitHub repository URL to the "dependencies" property.

ocelot.toml

This is an example of how an ocelot.toml file would look:

url = "github.com/ocelotpkg/mycoolpackage"
author = "200321dev"
version = "0.1.0"

dependencies = [
    "github.com/ocelotpkg/mycoolpackage2"
]