foundrycf / fpm

a package manager for foundry
http://fpmcf.org/
4 stars 2 forks source link

Finish source.cfc component and get fpm registry service online... #16

Closed jfrux closed 12 years ago

jfrux commented 12 years ago

This is done but I wanted to document the API a bit here...

The service is currently hosted at https://fpm.herokuapp.com/packages

There is no user database, just like twitter/bower it's first come first serve.

The source.cfc api works like this...

source.lookup(name,callback)

returns a url

source.register(name, packageUrl, callback)

returns a success / fail message from the server

source.info(name,callback)

returns a struct containing a Package object, and an array of Versions(tags) of this object.

source.search(q,callback)

returns error object, and a result array based on text search

source.all(callback)

returns all packages in the online fpm registry