Skip to content

Commit

Permalink
Merge pull request #6 from bow-swift/adjust_docs
Browse files Browse the repository at this point in the history
Hide imports in docs
  • Loading branch information
miguelangel-dev authored May 20, 2020
2 parents eff6e4c + a696ed1 commit 506646d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
title: Creating nested components
*/
// nef:end
// nef:begin:hidden
import SwiftUI
import Bow
import BowEffects
import BowOptics
import BowArch
// nef:end
/*:
# Creating nested components

Expand Down
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,20 @@
</a>

<a href="https://gitter.im/bowswift/bow">
<img src="https://img.shields.io/badge/Gitter-Bow%20Arch-red" alt="Gitter">
<img src="https://img.shields.io/badge/Gitter-Bow%20Arch-yellow" alt="Gitter">
</a>

<img src="https://img.shields.io/badge/platform-macOS%20%7C%20iOS-yellow">

<img src="https://github.com/bow-swift/bow-arch/workflows/Deploy%20docs/badge.svg?branch=master">
</p>

# ๐Ÿน Bow Arch ๐Ÿ›
Welcome to Bow Arch!

**Bow Arch** is a library to [architect applications in pure Functional Programming](https://arch.bow-swift.io/docs/quick-start/getting-started/), based on the notion of [Comonadic User Interfaces](https://arch.bow-swift.io/docs/background/comonadic-uis/). Please, refer to the [project website](https://arch.bow-swift.io) for extensive documentation.

&nbsp;

## ๐Ÿ‘ฉโ€๐Ÿซ Principles

๐ŸŽจ **View as a function of state**: Using SwiftUI, we can create user interfaces in a declarative manner, that are a representation of a given state. The library goes even further and promotes the creation of views that are based on immutable state.
Expand All @@ -30,6 +34,8 @@

๐Ÿงฎ **Mathematical background**: Bow Arch is based on concepts from Category Theory, which brings soundness to the reasoning we can do about our code. Nonetheless, the API of the library hides the complexity of these concepts and users do not need to be experts in this topic to use the library in their applications.

&nbsp;

## ๐Ÿ’ป How to get it

Bow Arch is available through Swift Package Manager, integrated in Xcode. You only need to use the repository URL on GitHub and the version or branch you would like to use. Alternatively, you can describe this dependency in your `Package.swift` file by adding the line:
Expand All @@ -38,6 +44,8 @@ Bow Arch is available through Swift Package Manager, integrated in Xcode. You on
.package(url: "https://github.com/bow-swift/bow-arch.git", from: "{version}")
```

&nbsp;

## ๐Ÿ‘จโ€๐Ÿ’ป Usage

Bow Arch lets you architect your application in terms of components that can be reused across applications. Let's go over what you need to create in order to build a stepper component.
Expand Down Expand Up @@ -137,11 +145,15 @@ Components already conform to SwuiftUI `View`, so they can be used as part of ot
let controller = UIHostingController(rootView: stepperComponent)
```

&nbsp;

## ๐Ÿ‘ Acknowledgements

We want to thank [Arthur Xavier](https://github.com/arthurxavierx/purescript-comonad-rss/blob/master/RealWorldAppComonadicUI.pdf), [Phil Freeman](https://functorial.com/the-future-is-comonadic/main.pdf), and [Edward Kmett](https://hackage.haskell.org/package/comonad), for their previous work on Comonads and Comonadic UIs in the PureScript and Haskell languages. Their work has inspired the creation of this library.

# โš–๏ธ License
&nbsp;

## โš–๏ธ License

Copyright (C) 2020 The Bow Authors

Expand Down

0 comments on commit 506646d

Please sign in to comment.