Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need comprehensive documentation on file/URL response format #113

Closed
ghost opened this issue Jun 24, 2014 · 2 comments
Closed

Need comprehensive documentation on file/URL response format #113

ghost opened this issue Jun 24, 2014 · 2 comments

Comments

@ghost
Copy link

ghost commented Jun 24, 2014

I didn't see any documentation that totally covers the file format of watched files/scripts/URLs. For instance, if you watch report.txt which looks like this:

{
  pattern: "my pattern"
}

Then the pattern my pattern is executed. But what else can we do with this format? How do we specify an on-the-fly custom pattern? How do we specify multiple colors? I tried this and it didn't work:

{
  color: [ "#ff0000", "#00ff00" ]
}

But I'm just making guesses here. Is there documentation on what we can have a file contain (or script return)?

@todbot
Copy link
Owner

todbot commented Jun 26, 2014

You are right, it's not documented. I just put together the start of a document describing possible formats here:
https://github.com/todbot/blink1/blob/master/docs/blink1control-file-script-url-format.md

Please note that the current release of Blink1Control has some parsing problems. A new release will be released later today.

@ghost
Copy link
Author

ghost commented Jun 26, 2014

Thanks, very helpful!

@todbot todbot closed this as completed Jul 3, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant