Skip to content

Commit

Permalink
spm: rename from walletui to bitcoinui
Browse files Browse the repository at this point in the history
  • Loading branch information
reez authored Aug 28, 2023
1 parent 51dac15 commit 7ca509e
Show file tree
Hide file tree
Showing 134 changed files with 51 additions and 51 deletions.
12 changes: 6 additions & 6 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
import PackageDescription

let package = Package(
name: "WalletUI",
name: "BitcoinUI",
platforms: [
.iOS(.v15)
],
products: [
// Products define the executables and libraries a package produces, and make them visible to other packages.
.library(
name: "WalletUI",
targets: ["WalletUI"])
name: "BitcoinUI",
targets: ["BitcoinUI"])
],
dependencies: [
// Dependencies declare other packages that this package depends on.
Expand All @@ -22,11 +22,11 @@ let package = Package(
// Targets are the basic building blocks of a package. A target can define a module or a test suite.
// Targets can depend on other targets in this package, and on products in packages this package depends on.
.target(
name: "WalletUI",
name: "BitcoinUI",
dependencies: []),
.testTarget(
name: "WalletUITests",
dependencies: ["WalletUI"]),
name: "BitcoinUITests",
dependencies: ["BitcoinUI"]),
]
)

Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
![cover image](/Docs/bitcoin-wallet-ui-kit-themes.png)

# WalletUI
# BitcoinUI

WalletUI is a native iOS implementation of [Bitcoin Wallet UI Kit](https://github.com/GBKS/bitcoin-wallet-ui-kit).
BitcoinUI is a native iOS implementation of [Bitcoin Wallet UI Kit](https://github.com/GBKS/bitcoin-wallet-ui-kit).

*Both WalletUI and its reference Bitcoin Wallet UI Kit are Work In Progress.*
*Both BitcoinUI and its reference Bitcoin Wallet UI Kit are Work In Progress.*

[What's Included](#whats-included)<br>
[Basic Usage](#basic-usage)<br>
Expand All @@ -13,7 +13,7 @@ WalletUI is a native iOS implementation of [Bitcoin Wallet UI Kit](https://githu

## What's Included

The design system in WalletUI includes:
The design system in BitcoinUI includes:

- Colors
- Button styles
Expand All @@ -22,16 +22,16 @@ The design system in WalletUI includes:

<p align='left'>
<a href='https://www.figma.com/community/file/916680391812923706/Bitcoin-Wallet-UI-Kit-(work-in-progress)'>
<img src='https://github.com/reez/WalletUI/blob/main/Docs/colors-dark.png?raw=true' height='200' alt='colors-code-preview' />
<img src='https://github.com/reez/BitcoinUI/blob/main/Docs/colors-dark.png?raw=true' height='200' alt='colors-code-preview' />
</a>
<a href='https://www.figma.com/community/file/916680391812923706/Bitcoin-Wallet-UI-Kit-(work-in-progress)'>
<img src='https://github.com/reez/WalletUI/blob/main/Docs/button-dark.png?raw=true' height='200' alt='buttons-code-preview' />
<img src='https://github.com/reez/BitcoinUI/blob/main/Docs/button-dark.png?raw=true' height='200' alt='buttons-code-preview' />
</a>
<a href='https://www.figma.com/community/file/916680391812923706/Bitcoin-Wallet-UI-Kit-(work-in-progress)'>
<img src='https://github.com/reez/WalletUI/blob/main/Docs/text-dark.png?raw=true' height='200' alt='text-code-preview' />
<img src='https://github.com/reez/BitcoinUI/blob/main/Docs/text-dark.png?raw=true' height='200' alt='text-code-preview' />
</a>
<a href='https://github.com/GBKS/bitcoin-hardware-illustrations'>
<img src='https://github.com/reez/WalletUI/blob/main/Docs/hardware-dark.png?raw=true' height='200' alt='hardware-illustrations-code-preview' />
<img src='https://github.com/reez/BitcoinUI/blob/main/Docs/hardware-dark.png?raw=true' height='200' alt='hardware-illustrations-code-preview' />
</a>
</p>

Expand Down Expand Up @@ -113,14 +113,14 @@ view.addSubview(imageView)

## Requirements

WalletUI currently requires minimum deployment targets of iOS 15.
BitcoinUI currently requires minimum deployment targets of iOS 15.

## Installation

You can add WalletUI to an Xcode project by adding it as a package dependency.
You can add BitcoinUI to an Xcode project by adding it as a package dependency.

1. From the **File** menu, select **Add Packages…**
2. Enter "https://github.com/reez/WalletUI" into the package repository URL text field
2. Enter "https://github.com/reez/BitcoinUI" into the package repository URL text field
3. Depending on how your project is structured:
- If you have a single application target that needs access to the library, then add **WalletUI** directly to your application.
- If you want to use this library from multiple targets you must create a shared framework that depends on **WalletUI** and then depend on that framework in all of your targets.
- If you have a single application target that needs access to the library, then add **BitcoinUI** directly to your application.
- If you want to use this library from multiple targets you must create a shared framework that depends on **BitcoinUI** and then depend on that framework in all of your targets.
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# ``WalletUI``
# ``BitcoinUI``

An iOS implementation of Bitcoin Wallet UI Kit, with example code implementations via Swift Previews.

## Overview

WalletUI provides functions and resources for easy access and implementation of the [Bitcoin UI Kit](https://github.com/GBKS/bitcoin-wallet-ui-kit) design system for applications:
BitcoinUI provides functions and resources for easy access and implementation of the [Bitcoin UI Kit](https://github.com/GBKS/bitcoin-wallet-ui-kit) design system for applications:

> "Many designers on Bitcoin products find themselves designing the same set of UI components that have already been thought through by others. The goal of this UI kit is to provide a strong foundation for prototypes, concept explorations and real projects to kickstart their design processes. By not having to worry about the basics, designers can then focus on what makes their products unique."
Expand Down
20 changes: 20 additions & 0 deletions Sources/BitcoinUI/BitcoinUI.docc/GettingStarted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Getting Started with BitcoinUI

How to install BitcoinUI in your application.

## Installation

You can add BitcoinUI to an Xcode project by adding it as a package dependency.

1. From the **File** menu, select **Swift Packages › Add Package Dependency…**
2. Enter "https://github.com/reez/BitcoinUI" into the package repository URL text field
3. Depending on how your project is structured:
- If you have a single application target that needs access to the library, then add **BitcoinUI** directly to your application.
- If you want to use this library from multiple targets you must create a shared framework that depends on **BitcoinUI** and then depend on that framework in all of your targets.

## Implementation

### Icons

- ``BitcoinImage(named:)``
- ``BitcoinUIImage(named:)``
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import SwiftUI
import WalletUI
import BitcoinUI

struct ColorsTutorial: View {
var body: some View {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import SwiftUI
import WalletUI
import BitcoinUI

struct ImagesTutorial: View {
var body: some View {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
}

@Step {
Here is what using a Bitcoin `Color` would look like. Just `import WalletUI`.
Here is what using a Bitcoin `Color` would look like. Just `import BitcoinUI`.
@Code(name: "Colors.swift", file: 01-02-colors.swift) {
@Image(source: 01-02-colors-preview-500.png, alt: "01-02-colors-preview")
}
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public func BitcoinImage(named: String) -> Image {
/// - Returns: The specific Bitcoin `UIImage`
public func BitcoinUIImage(named: String) -> UIImage {
guard let image = UIImage(named: named, in: .module, compatibleWith: nil) else {
assertionFailure("*No WalletUI Image Found*")
assertionFailure("*No BitcoinUI Image Found*")
return UIImage()
}
return image
Expand Down
File renamed without changes.
File renamed without changes.
20 changes: 0 additions & 20 deletions Sources/WalletUI/WalletUI.docc/GettingStarted.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import XCTest

@testable import WalletUI
@testable import BitcoinUI

final class WalletUITests: XCTestCase {
final class BitcoinUITests: XCTestCase {
func testExample() {
// This is an example of a functional test case.
// Use XCTAssert and related functions to verify your tests produce the correct
// results.
//XCTAssertEqual(WalletUI().text, "Hello, World!")
//XCTAssertEqual(BitcoinUI().text, "Hello, World!")
}

static var allTests = [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import XCTest
#if !canImport(ObjectiveC)
public func allTests() -> [XCTestCaseEntry] {
return [
testCase(WalletUITests.allTests)
testCase(BitcoinUITests.allTests)
]
}
#endif
4 changes: 2 additions & 2 deletions Tests/LinuxMain.swift
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import WalletUITests
import BitcoinUITests
import XCTest

var tests = [XCTestCaseEntry]()
tests += WalletUITests.allTests()
tests += BitcoinUITests.allTests()
XCTMain(tests)

0 comments on commit 7ca509e

Please sign in to comment.