Skip to content

Commit 1e99af1

Browse files
authored
Update README.md
1 parent 5c90fc0 commit 1e99af1

File tree

1 file changed

+82
-1
lines changed

1 file changed

+82
-1
lines changed

README.md

Lines changed: 82 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# ModuleInterface
22
[![Build Status](https://travis-ci.org/minuscorp/ModuleInterface.svg?branch=master)](https://travis-ci.org/minuscorp/ModuleInterface)
3+
![GitHub release (latest by date)](https://img.shields.io/github/v/release/minuscorp/ModuleInterface)
4+
![License](https://img.shields.io/static/v1?label=License&message=Apache&color=blue)
5+
![Swift version](https://img.shields.io/badge/Swift-5.1-orange)
6+
![Twitter Follow](https://img.shields.io/twitter/follow/minuscorp?style=social)
37

48
Swift tool to generate Module Interfaces for Swift projects.
59

@@ -26,6 +30,83 @@ help Display general or command-specific help
2630
version Display the current version of ModuleInterface
2731
```
2832

29-
Typing `moduleinterfacep` help <command> we get a list of all options for that command
33+
Typing `moduleinterfacep` help <command> we get a list of all options for that command:
3034

35+
```
36+
Generates the Swift Module Interface.
37+
38+
[--spm-module (string)]
39+
Generate documentation for Swift Package Manager module.
40+
41+
[--module-name (string)]
42+
Generate documentation for a Swift module.
43+
44+
[--input-folder (string)]
45+
Path to the input directory (defaults to /Users/minuscorp/Documents/GitHub/ModuleInterface).
46+
47+
[--output-folder (string)]
48+
Output directory (defaults to Documentation).
49+
50+
[--min-acl (string)]
51+
The minimum access level to generate documentation. Defaults to public.
52+
53+
--clean|-c
54+
Delete output folder before generating documentation.
55+
56+
[[]]
57+
List of arguments to pass to xcodebuild.
58+
```
59+
60+
Usually, for most Xcode projects, no parameters are needed at all. xcodebuild should be able to find the default project and scheme.
61+
62+
If the command fails, try specifying the scheme (-scheme SchemeName) or the workspace. Any arguments passed to sourcedocs after -- will be passed to xcodebuild without modification.
63+
64+
`$ moduleinterface generate -- -scheme MyScheme`
65+
66+
For Swift Package Manager modules, you can the module name using the --spm-module parameter.
67+
68+
`$ moduleinterface generate --spm-module ModuleInterface`
69+
70+
## Installation
71+
72+
### Download Binary
73+
74+
```
75+
$ curl -Ls https://github.com/minuscorp/ModuleInterface/releases/download/latest/moduleinterface.macos.zip -o /tmp/moduleinterface.macos.zip
76+
$ unzip -j -d /usr/local/bin /tmp/moduleinterface.macos.zip
77+
```
78+
79+
### From Sources
80+
Requirements:
81+
82+
Swift 5.1 runtime and Xcode installed in your computer.
83+
84+
### Using Homebrew
85+
86+
**Soon**
87+
88+
### Building with Swift Package Manager
89+
90+
```
91+
$ git clone https://github.com/minuscorp/ModuleInterface.git
92+
$ cd ModuleInterface
93+
$ make
94+
```
95+
96+
## Contact
97+
98+
Follow and contact me on Twitter at [@minuscorp](https://twitter.com/minuscorp).
99+
100+
## Contributions
101+
102+
If you find an issue, just [open a ticket](https://github.com/minuscorp/ModuleInterface/issues/new) on it. Pull requests are warmly welcome as well.
103+
104+
## License
105+
106+
ModuleInterface is licensed under the Apache 2.0. See [LICENSE](https://github.com/minuscorp/ModuleInterface/blob/master/LICENSE) for more info.
107+
108+
## Acknowledegments
31109

110+
- To [@eneko](https://twitter.com/eneko) for giving me the tooling idea.
111+
- To [SourceKitten](https://github.com/jpsim/SourceKitten) for providing such an awesome Framework for dealing with SourceKit.
112+
- To [BQ](https://github.com/bq) for all the mentoring.

0 commit comments

Comments
 (0)