Skip to content

Commit c95c82e

Browse files
Update README.md
Co-Authored-By: Tomás Ruiz-López <[email protected]> Update contents/Documentation/Tutorials.playground/Pages/How to use nef library?.xcplaygroundpage/Contents.swift Co-Authored-By: Tomás Ruiz-López <[email protected]> Update contents/Documentation/Tutorials.playground/Pages/How to use nef library?.xcplaygroundpage/Contents.swift Co-Authored-By: Tomás Ruiz-López <[email protected]> Update contents/Documentation/Tutorials.playground/Pages/How to use nef library?.xcplaygroundpage/Contents.swift Co-Authored-By: Tomás Ruiz-López <[email protected]> Update contents/Documentation/Tutorials.playground/Pages/How to use nef library?.xcplaygroundpage/Contents.swift Co-Authored-By: Tomás Ruiz-López <[email protected]>
1 parent 9feb658 commit c95c82e

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
</p>
1818

19-
`nef`, short for [Nefertiti](https://en.wikipedia.org/wiki/Nefertiti), mother of Ankhesenamun, is a set tool to ease the **creation of documentation** in the form of Xcode Playgrounds. It provides compile-time **verification** of documentation, exports it in **Markdown** format that can be consumed by [Jekyll](https://jekyllrb.com/) to generate websites, and export [Carbon](https://carbon.now.sh/) snippets for given Xcode Playground.
19+
`nef`, short for [Nefertiti](https://en.wikipedia.org/wiki/Nefertiti), mother of Ankhesenamun, is a toolset to ease the **creation of documentation** in the form of Xcode Playgrounds. It provides compile-time **verification** of documentation, exports it in **Markdown** format that can be consumed by [Jekyll](https://jekyllrb.com/) to generate websites, and export [Carbon](https://carbon.now.sh/) snippets for a given Xcode Playground.
2020

2121
`nef` is inspired by [ΛNK](https://github.com/arrow-kt/ank) for Kotlin and [tut](https://github.com/tpolecat/tut) for Scala.
2222

contents/Documentation/Tutorials.playground/Pages/How to use nef library?.xcplaygroundpage/Contents.swift

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Nef.Playground.needsIndefiniteExecution(false)
1212
/*:
1313
## How to use `nef` library?
1414

15-
As you know, from Xcode 11, you can integrate package dependencies using SPM to share code between projects or even use third-party libraries. You can read more about it in Apple's article [Adding package dependencies to your app](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app)
15+
As you know, from Xcode 11, you can integrate package dependencies using Swift Package Manager (SPM) to share code between projects or even use third-party libraries. You can read more about it in Apple's article [Adding package dependencies to your app](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app)
1616

1717
In `nef` [version 0.4](https://github.com/bow-swift/nef/releases/tag/0.4.0), we have modularized the core so that you can use nef as in CLI as in your macOS projects. Taking advantage of the integration of SPM in Xcode, you can easily import `nef` in your project.
1818

@@ -42,7 +42,7 @@ If you need to render the content of a Playground page, or anything else that co
4242

4343
### Jekyll
4444

45-
When you need to render a content that combine Markdown, code, and [**nef commands**](https://github.com/bow-swift/nef#-generating-markdown-files-for-jekyll) with the Jekyll style.
45+
When you need to render content that combines Markdown, code, and [**nef commands**](https://github.com/bow-swift/nef#-generating-markdown-files-for-jekyll) with the Jekyll style.
4646

4747
```swift
4848
nef.Jekyll.render(content: String, toFile file: URL, permalink: String) -> IO<nef.Error, URL>
@@ -57,7 +57,7 @@ If you need to render the content of a Playground page, or anything else that co
5757
```
5858

5959

60-
You can find anothers helpers for drawing `Views` with a Carbon style.
60+
You can find other helpers for drawing `Views` with a Carbon style.
6161

6262
```swift
6363
nef.Carbon.view(with configuration: CarbonModel) -> CarbonView
@@ -69,7 +69,7 @@ If you need to render the content of a Playground page, or anything else that co
6969
/*:
7070
## Usage
7171

72-
In this section, we will see how we can use the nef's API. As an example, we will take advantage of the `Carbon API`.
72+
In this section, we will see how we can use the nef API. As an example, we will take advantage of the `Carbon API`.
7373

7474
Firstly, we need to create a model with Carbon configuration and the style.
7575
```swift

0 commit comments

Comments
 (0)