vhad/SwiftGit2
1
0
Fork 0
mirror of https://github.com/gosticks/SwiftGit2.git synced 2025-10-16 11:55:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #5 from mdiep/readme

Browse Source 
Start a README
This commit is contained in:
Matt Diephouse 2014-11-21 21:19:25 -05:00
commit a6ad10635b
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# SwiftGit2
Swift bindings to [libgit2](https://github.com/libgit2/libgit2).
## Design
SwiftGit2 uses value objects wherever possible. That means using Swift’s `struct`s and `enum`s without holding references to libgit2 objects. This has a number of advantages:
1. Values can be used concurrently.
2. Consuming values won’t result in disk access.
3. Disk access can be contained to a smaller number of APIs.
This vastly simplifies the design of long-lived applications, which are the most common use case with Swift.
Consequently, SwiftGit2 APIs don’t necessarily map 1-to-1 with libgit2 APIs.
## Contributions
We :heart: to receive pull requests! GitHub makes it easy:
1. Fork the repository
2. Create a branch with your changes
3. Send a Pull Request
All contributions should match GitHub’s [Swift Style Guide](https://github.com/github/swift-style-guide).
## License
SwiftGit2 is available under the MIT license.