Update readme

aheze · Sep 27, 2022 · 565d3de · 565d3de
1 parent 8f1be89
commit 565d3de
Show file tree

Hide file tree

Showing 5 changed files with 92 additions and 2 deletions.
diff --git a/Assets/Example.png b/Assets/Example.png
diff --git a/Assets/Find.mp4 b/Assets/Find.mp4
diff --git a/Assets/Result.png b/Assets/Result.png
diff --git a/Example/PrismExample/PrismExample/ContentView.swift b/Example/PrismExample/PrismExample/ContentView.swift
@@ -49,7 +49,7 @@ struct ExampleSliderView: View {
     var body: some View {
         GridRow {
             Text(title)
-                .gridColumnAlignment(.leading)
+                .gridColumnAlignment(.leading)#imageLiteral(resourceName: "simulator_screenshot_B59F966E-3178-4089-A417-356509865257.png")
                 .padding(.vertical, 6)
 
             Slider(value: $value, in: range)

diff --git a/README.md b/README.md
@@ -8,5 +8,95 @@ A lightweight 3D renderer for SwiftUI.
 - 100% SwiftUI. No SceneKit or other weird stuff.
 - Supports sizing, extrusion, levitation, and more.
 
-![](Assets/Logo.png) | ![](Assets/Transform.gif) | ![](Assets/Bounce.gif) | ![](Assets/Gradient.png) | ![](Assets/Image.png)
+![Logo cube](Assets/Logo.png) | ![Square that animates into a cube, with border](Assets/Transform.gif) | ![3 green cubes that bounce on click](Assets/Bounce.gif) | ![Thin, levitating blue prism](Assets/Gradient.png) | ![Prism with an image on each side](Assets/Image.png)
 --- | --- | --- | --- | ---
+
+## Installation
+
+Requires iOS 13+. Prism can be installed through the [Swift Package Manager](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app).
+
+```
+https://github.com/aheze/Prism
+```
+
+## Usage
+
+Prism is designed to be easy to use. First, define a `PrismConfiguration` for customization. Then just add a `PrismCanvas`, which can contain as many `PrismView`s as you'd like.
+
+```swift
+struct ContentView: View {
+    @State var configuration = PrismConfiguration(
+        tilt: 0.5, /// A value from 0 to 1, representing the perspective.
+        size: CGSize(width: 200, height: 200), /// How big the prism is.
+        extrusion: 100, /// The z height.
+        levitation: 20, /// How far the prism is from the ground.
+        shadowColor: Color.black, /// A dynamic shadow that's rendered underneath the prism.
+        shadowOpacity: 0.25 /// The strength of the shadow.
+    )
+
+    var body: some View {
+        PrismCanvas(tilt: configuration.tilt) {
+            PrismView(configuration: configuration) {
+                Color.blue
+            } left: {
+                Color.red
+            } right: {
+                Color.green
+            }
+        }
+    }
+}
+```
+
+<img src="Assets/Result.png" width="300" alt="Result, a multicolored cube">
+
+## Example
+
+Includes various samples of the library. [Download](https://github.com/aheze/Prism/archive/refs/heads/main.zip) it here!
+
+<img src="Assets/Example.png" width="300" alt="Screenshot of example app">
+
+
+## Community
+### Author
+Popovers is made by [aheze](https://github.com/aheze).
+
+### Contributing
+All contributions are welcome. Just [fork](https://github.com/aheze/Prism/fork) the repo, then make a pull request.
+
+### Need Help?
+Open an [issue](https://github.com/aheze/Prism/issues) or join the [Discord server](https://discord.com/invite/Pmq8fYcus2). You can also ping me on [Twitter](https://twitter.com/aheze0). Or read the source code — there's lots of comments.
+
+### Apps Using Popovers
+
+[Find](http://getfind.app/) is an app that lets you find text in real life. Popovers is currently used for the search bar settings and the camera message view — download to check it out!
+
+
+
+If you have an app that uses Popovers, just make a PR or [message me](https://twitter.com/aheze0).
+
+## License
+
+```
+MIT License
+
+Copyright (c) 2022 A. Zheng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```