From 340d66dd13591618fb4287efb6e9ffea882d2911 Mon Sep 17 00:00:00 2001 From: Cameron Kozlin <54863526+ckozlin@users.noreply.github.com> Date: Thu, 8 Sep 2022 13:46:08 -0400 Subject: [PATCH] Update README.md Various changes to the README file to increase readability and detail. This includes a detailed description, a "how to use" section with demo images, a development setup guide, and a license section. These changes should help future users understand the app more easily, providing a solid understanding so they can decide whether to download the app. It will also help future contributors to onboard quickly. --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 44 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1d637a8..224c9bc 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,51 @@ # Lantern -Crawl and audit websites. Written in Swift 5. +## Description + +Lantern is a Swift 5 application that allows users to easily crawl and audit websites. This makes it simple to debug website issues and enhance search engine optimization. It is available for free on the [Mac App Store](https://itunes.apple.com/us/app/lantern-website-crawler-for/id991526452?ls=1&mt=12). + +### Why Lantern? + +Lantern allows users to efficiently audit their websites through a UI. Being able to dig underneath the surface and examine sites at the meta level can lead to powerful findings and significant optimization. + +### How To Use + +Simply type the URL you wish to crawl into Lantern's search bar, and from there you will be able to investigate metadata, embedded content, and links through the user interface. + +Lantern standard view. Browser on left, metadata on right. + +In this example image, the user is investigating the images on their website and able to ensure that they all appear as expected. + +Lantern standard view. User is looking at title data of a site's home page + +This example shows how a user could quickly investigate title related data using Lantern. Simply navigate to the site and select the "Titles" tab. + + +When done, click "stop crawling" or enter a new address into the search bar. + + + + +## Developer Setup Guide + +This project uses [Carthage](https://github.com/Carthage/Carthage) to manage dependencies. + +Set up a local repository by following the steps below +1. `git clone https://github.com/RoyalIcing/Lantern.git` +1. `cd Lantern` +1. `brew install carthage` +1. `carthage update --use-xcframeworks` +1. Open in [XCode](https://developer.apple.com/xcode/) to start editing. ## Links [Download on the Mac App Store](https://itunes.apple.com/us/app/lantern-website-crawler-for/id991526452?ls=1&mt=12) -[Home Website](https://icing.space/tools/lantern/) +[Developer site](https://icing.space/) [Back on Open Collective](https://opencollective.com/lantern) -## Libraries +## Libraries Uses: - [Grain data flow for Swift](https://github.com/BurntCaramel/Grain) @@ -19,3 +54,9 @@ Uses: - [WebKit](https://www.webkit.org) - [Alamofire](https://github.com/Alamofire/Alamofire) - [Ono](https://github.com/mattt/Ono) + +## License + +Lantern is released under the [Apache-2.0 License](https://github.com/RoyalIcing/Lantern/blob/master/LICENSE). + +Example demos include images from https://www.burntcaramel.com/.