Skip to content

Commit

Permalink
Add App Store information
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelmeuli committed May 15, 2020
1 parent 3d1ce99 commit 66e1d7b
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 10 deletions.
5 changes: 2 additions & 3 deletions Glance/SupportedFilesWC.xib
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<document type="com.apple.InterfaceBuilder3.Cocoa.XIB" version="3.0" toolsVersion="16096" targetRuntime="MacOSX.Cocoa" propertyAccessControl="none" useAutolayout="YES" customObjectInstantitationMethod="direct">
<dependencies>
<deployment identifier="macosx"/>
<plugIn identifier="com.apple.InterfaceBuilder.CocoaPlugin" version="16096"/>
<capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
</dependencies>
Expand Down Expand Up @@ -70,7 +69,7 @@
<paragraphStyle key="NSParagraphStyle" alignment="center" lineBreakMode="wordWrapping" baseWritingDirection="natural" tighteningFactorForTruncation="0.0"/>
</attributes>
</fragment>
<fragment content="Archives">
<fragment content="Archive">
<attributes>
<color key="NSColor" name="textColor" catalog="System" colorSpace="catalog"/>
<font key="NSFont" metaFont="systemBold"/>
Expand Down Expand Up @@ -104,7 +103,7 @@
<paragraphStyle key="NSParagraphStyle" alignment="center" lineBreakMode="wordWrapping" baseWritingDirection="natural" tighteningFactorForTruncation="0.0"/>
</attributes>
</fragment>
<fragment content="TSV">
<fragment content="Tab-separated values">
<attributes>
<color key="NSColor" name="textColor" catalog="System" colorSpace="catalog"/>
<font key="NSFont" size="13" name="HelveticaNeue-Bold"/>
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@

**All-in-one Quick Look plugin**

Glance provides QuickLook previews for various file types that macOS doesn't support out of the box.
See what's in your files without opening them!

Glance boosts your productivity by providing Quick Look previews for files that macOS doesn't support out of the box.

## Install

**Glance is available on the Mac App Store:** (TODO: Add link)

![App Store download link](./.github/download-badge.svg)

After opening the app for the first time, macOS will use Glance to generate previews for the supported file types.
After opening Glance for the first time, macOS will use the app to generate previews for the supported files.

TODO: Main app screenshot

Expand All @@ -24,21 +26,21 @@ TODO: Main app screenshot

TODO: Add screenshot

- **Archives**: `.tar`, `.tar.gz`, `.zip`
- **Archive**: `.tar`, `.tar.gz`, `.zip`

TODO: Add screenshot

- **Jupyter Notebook** (rendered using [`nbtohtml`](https://github.com/samuelmeuli/nbtohtml)): `.ipynb`

TODO: Add screenshot

- **TSV** (parsed using [SwiftCSV](https://github.com/swiftcsv/SwiftCSV)): `.tab`, `.tsv`
- **Tab-separated values** (parsed using [SwiftCSV](https://github.com/swiftcsv/SwiftCSV)): `.tab`, `.tsv`

TODO: Add screenshot

## FAQ

**There are existing QuickLook apps for some of the supported file types. Why create another one?**
**There are existing Quick Look apps for some of the supported file types. Why create another one?**

- Glance combines the features of many plugins into one and provides consistent and beautiful previews
- Glance is fully compatible with Dark Mode
Expand All @@ -59,7 +61,7 @@ Please feel free to [open an issue](https://github.com/samuelmeuli/glance/issues

**You claim to support [file type], but previews aren't showing up.**

Please note that Glance skips previews for large files.
Please note that Glance skips previews for large files to avoid slowing down your Mac.

It's possible that your file's extension or [UTI](https://en.wikipedia.org/wiki/Uniform_Type_Identifier) isn't associated with Glance. You can easily verify this:

Expand All @@ -78,4 +80,4 @@ To add previews for a new file extension, please follow these steps:
1. Create a new class for your file type in [this directory](./QLPlugin/Views/Previews/). It should implement the `Preview` protocol. See the other files in the directory for examples.
2. Match the file extension to your class in [`PreviewVCFactory.swift`](./QLPlugin/Views/PreviewVCFactory.swift).
3. Find your file's UTI by running `mdls -name kMDItemContentType -name kMDItemContentTypeTree /path/to/your/file`. Add it to `QLSupportedContentTypes` in [`Info.plist`](./QLPlugin/Info.plist).
4. Update [`README.md`](./README.md) and [`Credits.rtf`](./Glance/Credits.rtf).
4. Update [`README.md`](./README.md), [`Credits.rtf`](./Glance/Credits.rtf) and [`app-store-description.txt`](./app-store-description.txt).
15 changes: 15 additions & 0 deletions app-store-description.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
See what's in your files without opening them!

Glance boosts your productivity by providing Quick Look previews for files that macOS doesn't support out of the box.

Features:
• Beautiful file previews for various file types
• Previews visible in Quick Look, Finder and Spotlight
• Full compatibility with Dark Mode

Supported file types:
• Source code (.cpp, .js, .json, .py, .swift, .yml and many more)
• Markdown (.md, .markdown, .mdown, .mkdn, .mkd, .Rmd)
• Archive (.tar, .tar.gz, .zip)
• Jupyter Notebook (.ipynb)
• Tab-separated values (.tab, .tsv)
1 change: 1 addition & 0 deletions app-store-keywords.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
glance,quick,look,quicklook,plugin,preview,finder,spotlight,file,thumbnail

0 comments on commit 66e1d7b

Please sign in to comment.