Skip to content

README.md template for your swift open-source project

Notifications You must be signed in to change notification settings

awesome-labs/swift-readme-template

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 

Repository files navigation

Product Name

Short blurb about what your product does.

Swift Version Build Status License codebeat-badge

One to two paragraph statement about your product and what it does.

Installation

Add this project on your Package.swift

import PackageDescription

let package = Package(
    dependencies: [
        .Package(url: "https://github.com/user/project.git", majorVersion: 0, minor: 0)
    ]
)

Usage example

import Project
let proj = Class(param: String?)
proj.run()

Development setup

Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.

make install

Release History

  • 0.2.1
    • CHANGE: Update docs (module code remains unchanged)
  • 0.2.0
    • CHANGE: Remove setDefaultXYZ()
    • ADD: Add init()
  • 0.1.1
    • FIX: Crash when calling baz() (Thanks @GenerousContributorName!)
  • 0.1.0
    • The first proper release
    • CHANGE: Rename foo() to bar()
  • 0.0.1
    • Work in progress

Meta

Your Name – @YourTwitter[email protected]

Distributed under the XYZ license. See LICENSE for more information.

https://github.com/yourname/github-link

About

README.md template for your swift open-source project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published