events icon indicating copy to clipboard operation
events copied to clipboard

readme lacks use cased

Open setop opened this issue 3 years ago • 2 comments

This piece of code looks impressive. However, it is not obvious for a new comer what can be done with it. Do you have any example of application that has been built on top of it ? It would worth to mention that in the readme.

Regards

setop avatar Jun 12 '21 10:06 setop

@setop are you more curious about low-/code-level use-cases, or about high-level questions like what kinds of projects it is a good fit for?

Only answering as a user, but this pair from the bashup org may be your best bet for mature, documented public projects that use this events module:

  • https://github.com/bashup/.devkit
    • https://github.com/bashup/.devkit/blob/master/dk.md
  • https://github.com/bashup/doco
    • https://github.com/bashup/doco/blob/master/Config.md
    • https://github.com/bashup/doco/blob/master/Services.md

~AFAIK the only other public projects so far are mine~ I also have two, but they aren't very accessible as references (still ~early, unreleased, and undocumented).

abathur avatar Jun 13 '21 17:06 abathur

Also, Imposer and Mantle use it. In general, it's a tool for creating configurable and extensible tooling frameworks in shell script, where the tool handles basic structures but different actions need to be injected on a per-project basis. (Which really covers all of these examples.)

Leaving the ticket open for now, especially in case anybody has any other examples to suggest. :)

pjeby avatar Jun 13 '21 22:06 pjeby