Skip to content

Commit 236c356

Browse files
authored
Update README with doc links (#40)
This patch adds MIT license and updates README with useful links.
1 parent 313b727 commit 236c356

File tree

2 files changed

+43
-2
lines changed

2 files changed

+43
-2
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Yasha Bubnov
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1-
# PlotUI
1+
# [PlotUI](https://ploui.pages.dev) · [![Tests][Tests]](https://github.com/ybubnov/PlotUI)
22

3-
A description of this package.
3+
Integrate beautiful minimalistic plots into your app.
4+
5+
## Installation
6+
7+
You can use PlotUI as package dependency to your app using
8+
[Xcode](https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app):
9+
10+
```text
11+
github.com/ybubnov/PlotUI
12+
```
13+
14+
## Documentation
15+
16+
The [PlotUI Documentation](https://plotui.pages.dev) contains additional details on how
17+
to get started with PlotUI.
18+
19+
## License
20+
21+
PlotUI is [MIT licensed](LICENSE).
22+
23+
[Tests]: https://github.com/ybubnov/PlotUI/workflows/Tests/badge.svg

0 commit comments

Comments
 (0)