Add installation instructions to the generated README

JohnSundell / SwiftPlate

Easily generate cross platform Swift framework projects from the command line

MIT License

1.77k stars 88 forks source link

Add installation instructions to the generated README #47

Open JohnSundell opened 7 years ago

JohnSundell commented 7 years ago

As suggested by @krzysztofzablocki on Twitter, it would be great if the README file that SwiftPlate generates would contain instructions on how to install the generated framework using CocoaPods, Carthage and the Swift Package Manager.

agisilaos commented 7 years ago

Hey @JohnSundell I would love to start working on that Issue! Can you give me some more info about it?

JohnSundell commented 7 years ago

Happy to hear that @agisilaos 🎉

OK, so what I would suggest is to look at for example Wrap (https://github.com/johnsundell/wrap), and make SwiftPlate generate a similar Installation section in the README file it generates. Basically modify the template here: https://github.com/JohnSundell/SwiftPlate/blob/master/Template/README.md.

agisilaos commented 7 years ago

@JohnSundell Yup, got it! Makes sense! ☺️

agisilaos commented 7 years ago

Just made this pull request #49 for this specific issue. Let me know what you think @JohnSundell :)