lib/juici/views/README.markdown in juici-0.0.0.alpha1 vs lib/juici/views/README.markdown in juici-0.0.0
- old
+ new
@@ -11,12 +11,12 @@
* Queues can be dynamically created
* Build status visualised
## Important but Miscellaneous
-If you create child processes in modules/plugins then you need to register your
-disinterest or JuiCI will think they're builds and that would be bad.
+If you create child process in modules/plugins then you need to register your
+disinterest or JuiCI will think they're builds and that would be bad
## Setup
JuiCI is deliberately very light on the setup front.
@@ -25,30 +25,16 @@
bundle exec bin/juici
```
is all you need to have a working instance (provided that you have mongo installed)
-### Gotchas
-
-Make sure you don't do something innocuous like
-
-```bash
-bundle install --path .bundle
-```
-
-this might look sane (and it is, kinda) but owing to a quick in bundler, it
-will break any ruby code you try to build.
-
-I'm working on a workaround, but in the meantime the fix is to not do it!
-
## Usage
-JuiCI is very focused on minimal configuration; meaning that beyond starting
-the server and pointing it at a mongoDB instance, you do not need to do
-anything special to build a new project. Just request a build; however this
-means that on your first build you will need to send the commands to create
-your test environment)
+JuiCI chooses to be very "Mongo" (which is an adjective now), in that you don't
+need to formally create a project. Just request a build; however this means
+that on your first build you will need to send the commands to create your test
+environment)
Example:
```bash
curl --data-ascii @/dev/stdin <<EOF
@@ -79,24 +65,10 @@
You may specify one or more callbacks when you request a build. They will be
called with an (as yet unformalised) json body as the body if/when the build
reaches that state. Alternately you may specify "any" as the callback state and
it will be called on all state changes.
-## Integration
-
-Apps written in ruby wanting to interact with Juici can include the
-`juici-interface` gem, which presently exposes a few constants to line up with
-JuiCI's internal state.
-Over time this will be expanded, but for now they are:
-
-```ruby
-Juici::BuildStatus::PASS
-Juici::BuildStatus::FAIL
-Juici::BuildStatus::START
-Juici::BuildStatus::WAIT
-```
-
## Security
JuiCI poses some interesting security conecerns. First off, it will allow
anyone with access to run arbitrary commands on your server. I have
deliberately not implemented any kind of security inside JuiCI, it plays nicely
@@ -118,21 +90,10 @@
What this means to you as the user though is that unless you go to lengths to
specifically implement it, your process won't see any of the signal handling
madness. The shell(`/bin/sh`) will see everything, and if killed, your
processes will become orphaned, but carry on.
-## Authors
-
-* [Richo Healey](https://github.com/rcho)
-* [Alec Sloman](https://github.com/alecsloman)
-
## Contact
JuiCI's code lives on [Github](https://github.com/richo/juici)
and the [author](mailto:richo@psych0tik.net) can be contacted on
[Twitter](https://twitter.com/rich0H)
-
-## Legalese
-
-(c) Richo Healey 2012, richo@psych0tik.net
-
-Released under the terms of the MIT license.