Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kspurgin committed Jul 20, 2021
1 parent 5c240f8 commit f4e4e7a
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ Kiba is a [Data processing & ETL framework for Ruby](https://github.com/thbar/ki

kiba-extend is a suite of extensions useful in transformations and reshaping data in migrations.

[mimsy-to-cspace](https://github.com/lyrasis/mimsy-to-cspace) is a publicly available example of kiba-extend usage.
[mimsy-to-cspace](https://github.com/lyrasis/mimsy-to-cspace) is a publicly available example of `kiba-extend` usage.

Current projects in the Lyrasis `migrations-private` repo will reflect my preferred practices for structuring Kiba jobs, which may have changed since the project that resulted in the current iteration of `mimsy-to-cspace`.
Current projects in the Lyrasis `migrations-private` repo reflect my preferred practices for structuring Kiba-based projects, which have changed since the project that resulted in the current iteration of `mimsy-to-cspace`.

There's no time to write up nice documentation for this, so the easiest way to get a sense of the available extensions is to run `rake spec` from the repo base directory.
I am working on better documentation for the transformations included in `kiba-extend`, which is available at https://lyrasis.github.io/kiba-extend/

That will give you the names of all the transformations in `kiba-extend` and hopefully a vague sense of what they do.
To get a full overview of available transformations and what they do, run `rake spec` from the repo base directory. This will give you the names of all the transformations in `kiba-extend` and brief descriptions of what they do.

For more clarity about what each transformation does, check the actual test files in `/spec`. I try to write the tests so that I can go back later and look at them to remind myself of what each thing does.
For more clarity about exactly what each transformation does, if it is not described in the documentation yet, check the actual test files in `/spec/kiba/extend/transforms`.

0 comments on commit f4e4e7a

Please sign in to comment.