Document commit integration in README directly

shibapm / Komondor

Git Hooks for Swift projects 🐩

MIT License

552 stars 32 forks source link

Document commit integration in README directly #18

Closed Jeehut closed 5 years ago

Jeehut commented 5 years ago

I just wanted to test this out, but after reading the README I wasn't sure at first how commit hooks would get setup in my project since the swift run komondor install method was only documented within the "Getting Set Up" documents, but I personally think it's the key command and should be explained right within the README.

orta commented 5 years ago

Sure, happy to accept a PR 👍

Jeehut commented 5 years ago

I would happily post a PR, but first to understand it correctly: In the SwiftPM "Getting Set Up" there is no mentions of the swift run komondor install command, is it even needed in that case?

orta commented 5 years ago

Yep, should be - likely is an oversight

Jeehut commented 5 years ago

Ah, no, the swift run komondor install command is already mentioned in the README. So this might not have been an issue in the end. Must have overseen it. Closing.