doc: Recorded screencast and updated of readme

... to be more attractive. Inspired by https://github.com/faressoft/terminalizer/blob/master/README.md
This commit is contained in:
Aravindo Wingeier
2021-01-03 22:36:11 +01:00
committed by GitHub
parent b93d6822ac
commit 658e8ac096

View File

@@ -6,42 +6,43 @@
[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-) [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END --> <!-- ALL-CONTRIBUTORS-BADGE:END -->
- [OSXPhotos](#osxphotos) > OSXPhotos provides the ability to interact with and query Apple's Photos.app library on macOS. You can query the Photos library database — for example, file name, file path, and metadata such as keywords/tags, persons/faces, albums, etc. You can also easily export both the original and edited photos.
* [What is osxphotos?](#what-is-osxphotos)
* [Supported operating systems](#supported-operating-systems) <p align="center"><img src="docs/screencast/demo.gif?raw=true" width="713" height="430"/></p>
* [Installation instructions](#installation-instructions)
* [Command Line Usage](#command-line-usage) # Table of Contents
+ [Command line examples](#command-line-examples) * [Supported operating systems](#supported-operating-systems)
+ [Command line reference: export](#command-line-reference-export) * [Installation instructions](#installation-instructions)
* [Package Interface](#package-interface) * [Command Line Usage](#command-line-usage)
+ [PhotosDB](#photosdb) + [Command line examples](#command-line-examples)
+ [PhotoInfo](#photoinfo) + [Command line reference: export](#command-line-reference-export)
+ [ExifInfo](#exifinfo) * [Package Interface](#package-interface)
+ [AlbumInfo](#albuminfo) + [PhotosDB](#photosdb)
+ [ImportInfo](#importinfo) + [PhotoInfo](#photoinfo)
+ [FolderInfo](#folderinfo) + [ExifInfo](#exifinfo)
+ [PlaceInfo](#placeinfo) + [AlbumInfo](#albuminfo)
+ [ScoreInfo](#scoreinfo) + [ImportInfo](#importinfo)
+ [SearchInfo](#searchinfo) + [FolderInfo](#folderinfo)
+ [PersonInfo](#personinfo) + [PlaceInfo](#placeinfo)
+ [FaceInfo](#faceinfo) + [ScoreInfo](#scoreinfo)
+ [CommentInfo](#commentinfo) + [SearchInfo](#searchinfo)
+ [LikeInfo](#likeinfo) + [PersonInfo](#personinfo)
+ [Raw Photos](#raw-photos) + [FaceInfo](#faceinfo)
+ [Template Substitutions](#template-substitutions) + [CommentInfo](#commentinfo)
+ [Utility Functions](#utility-functions) + [LikeInfo](#likeinfo)
* [Examples](#examples) + [Raw Photos](#raw-photos)
* [Related Projects](#related-projects) + [Template Substitutions](#template-substitutions)
* [Contributing](#contributing) + [Utility Functions](#utility-functions)
* [Known Bugs](#known-bugs) * [Examples](#examples)
* [Implementation Notes](#implementation-notes) * [Related Projects](#related-projects)
* [Dependencies](#dependencies) * [Contributing](#contributing)
* [Acknowledgements](#acknowledgements) * [Known Bugs](#known-bugs)
* [Implementation Notes](#implementation-notes)
* [Dependencies](#dependencies)
* [Acknowledgements](#acknowledgements)
## What is osxphotos?
OSXPhotos provides the ability to interact with and query Apple's Photos.app library on macOS. You can query the Photos library database -- for example, file name, file path, and metadata such as keywords/tags, persons/faces, albums, etc. You can also easily export both the original and edited photos.
## Supported operating systems ## Supported operating systems