Skip to content
This repository has been archived by the owner on Jan 25, 2020. It is now read-only.

Where to find documentation? #120

Open
goloroden opened this issue May 25, 2016 · 3 comments
Open

Where to find documentation? #120

goloroden opened this issue May 25, 2016 · 3 comments

Comments

@goloroden
Copy link

I am currently trying to get kappa up and running, and I wonder where the documentation for this module is.

Of course we have the README.md, but e.g., it does not describe how to configure kappa.

Is there some more documentation available? If so, where?

@shaunwarman
Copy link
Member

There is a global and local setup in the example section.

It looks like your issue #119 will be fixed via #122 ... just waiting for one more 👍

@StarpTech
Copy link

I'm also looking for clean documentation.

  1. How to setup kappa with couchdb
  2. Publish a package

@shaunwarman
Copy link
Member

shaunwarman commented Feb 23, 2017

Hey @StarpTech @goloroden

You can check out the example section for a local and global setup.

Or even easier is to use the docker-compose.yml file and with docker-compose setup locally you can just run docker-compose up and it will pull down the couchDB docker image and kappa images from docker hub, build them and start them up locally with everything running. From there you can hit kappa with an npm install.

Let me know if this is confusing or if I can add additional documentation or help.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants