From 71eacfd60136b7fadbda64a58cdcb0a827e67800 Mon Sep 17 00:00:00 2001 From: lunaceee Date: Mon, 25 Feb 2019 13:49:28 -0800 Subject: [PATCH] Update README --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4a47470..bb37704 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Netlify Status](https://api.netlify.com/api/v1/badges/4d853017-7159-4520-b9ee-cc9951715434/deploy-status)](https://app.netlify.com/sites/netlify-photo-gallery/deploys) -This is a photo gallery demo project for Netlify Large Media made with the photos from [Unsplash](https://unsplash.com/) and Hugo. +This is a photo gallery demo project for Netlify Large Media made with the photos from [Unsplash](https://unsplash.com/) and built with [Hugo](https://gohugo.io/). This project has two branches: @@ -10,11 +10,9 @@ This project has two branches: * **large-media-sample:** A photo gallery that uses Netlify Large Media feature. You can go to a [static/images](https://github.com/netlify/netlify-photo-gallery/tree/large-media-sample/static/images) folder to see how large media assets are managed with Git. This branch is deployed as [https://netlify-photo-gallery.netlify.com/](https://netlify-photo-gallery.netlify.com/) demo page. -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify/netlify-photo-gallery) - ## How to play with this -1. Deploy to Netlify with "Deploy to Netlify" button. This will create a new Netlify site and copy the repo to your GitHub account. +1. Deploy to Netlify with [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify/netlify-photo-gallery) button. This will create a new Netlify site and copy the repo to your GitHub account. 2. Clone a newly created repo to your local computer with `git clone`. 3. `netlify link` to link the local repo and the Netlify site. * Make sure to install Netlify CLI if you haven't: `npm install netlify-cli -g`. @@ -22,11 +20,10 @@ This project has two branches: * You can check it with `netlify lm:info` command. * Make sure to install netlify-lm-plugin plugin if you haven't: `netlify plugins:install netlify-lm-plugin`. 5. Run `netlify lm:setup` to setup the Large Media for this repository/site. - * It will create a `.lfsconfig` file, make sure that you track this file. -6. Tweak the LFS settings with `git lfs` commands. - * This example contains jpg and png files, and expected that both of them are tracked by LFS. + * It will create a `.lfsconfig` file, make sure you track this file. +6. Tweak the LFS settings with the `git lfs` commands. The follow example contains `jpg` and `png` files, and expects that both of them are tracked by LFS: * To track jpg files: `git lfs track *.jpg`. * To track png files: `git lfs track *.png`. * To track all files under `static/images`: `git lfs track static/images/**`. -7. `git push origin master` to push to the GitHub. It'll be automatically deployed to Netlify utlizing Large Media. -8. Try transformations with image files. You can tweak the layout file like `layouts/photos_s/list.html`. +7. Run `git push origin master` to push your changes to GitHub. It'll be automatically deployed to Netlify utlizing Large Media. +8. Try transformations with image files. For example, you can tweak the layout file with `layouts/photos_s/list.html`.