Skip to content

Commit

Permalink
Fixes typos and clarifies text in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Danjohnsonnj committed Oct 16, 2018
1 parent 4399e54 commit cf2dc03
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -12,17 +12,17 @@ Bulksplash is now powered by the official Unsplash API. The new API gives us acc
* You can now download images with a specific search query
* You can now choose the orientation of the images

Additionally, the images are now saved in the `images` folder grouped by the search term, or `images/random` is no search term is supplied. The photo's file name will contain the photographer's Unsplash username and the photo's unique ID. This will allow you to keep adding new images to you search folders each time.
Additionally, the images are now saved in the `images` folder grouped by the search term, or `images/random` if no search term is supplied. The photo's file name will contain the photographer's Unsplash username and the photo's unique ID. This will allow you to keep adding new images to your existing folders.

## Getting Started

To get started with Bulksplash, simply clone the repo, install the modules with `npm install` and run `node index`

Prompts in the terminal will guide you through the options for downloading images, with some default values for quicker use. The prompts are as follows:

* `How many images (up to 50)?` - How many images should it get, up to 50. _Defaults to 20_
* `How many images (up to 50)?` - The number of images to retrieve. _Defaults to 20_
* `What search term?` - A search term, or blank for random images. _Defaults to blank_
* `Only featured images?` - Should it only get featured Unsplash images? _Defaults to `Yes`_
* `Only featured images?` - Should it only get featured images, curated by Unsplash? _Defaults to `Yes`_
* `What orientation?` - What orientation should the images be? The options are `Mixed`, `Portrait`, `Landscape`, `Squarish`, or `Custom`. `Mixed` will get images regardless of orientation, while `Custom` allows you to choose a specific width and height. _Defaults to `Mixed`_
* `Width?` - For any orientation, choose the width of the returned images. This is required when the `Custom` orientation is selected. _Defaults to blank for original size_
* `Height?` - For `Custom` orientation, specify a height. This option is not displayed if the orientation is not `Custom` and a width is specified. _Defaults to blank for original size_
Expand Down

0 comments on commit cf2dc03

Please sign in to comment.