From 2b73f9f5141065d8ea2548135da82081269a7f50 Mon Sep 17 00:00:00 2001 From: Dylan Vann Date: Tue, 18 Apr 2017 01:45:28 -0400 Subject: [PATCH] Document running example server and move server directory. --- .npmignore | 1 + example/README.md | 23 ++++++++++++++++++ {example/server => server}/index.js | 0 {example/server => server}/package.json | 0 .../pictures/ahmed-saffu-235616.jpg | Bin .../pictures/alex-bertha-236361.jpg | Bin .../pictures/jaromir-kavan-233699.jpg | Bin .../pictures/martin-sanchez-143239.jpg | Bin {example/server => server}/yarn.lock | 0 9 files changed, 24 insertions(+) create mode 100644 example/README.md rename {example/server => server}/index.js (100%) rename {example/server => server}/package.json (100%) rename {example/server => server}/pictures/ahmed-saffu-235616.jpg (100%) rename {example/server => server}/pictures/alex-bertha-236361.jpg (100%) rename {example/server => server}/pictures/jaromir-kavan-233699.jpg (100%) rename {example/server => server}/pictures/martin-sanchez-143239.jpg (100%) rename {example/server => server}/yarn.lock (100%) diff --git a/.npmignore b/.npmignore index a89774d..68ea6e3 100644 --- a/.npmignore +++ b/.npmignore @@ -2,3 +2,4 @@ ios/FastImage/Libraries/SDWebImage/.git* ios/FastImage/Libraries/SDWebImage/Examples ios/FastImage/Libraries/SDWebImage/Tests example +server diff --git a/example/README.md b/example/README.md new file mode 100644 index 0000000..26e330d --- /dev/null +++ b/example/README.md @@ -0,0 +1,23 @@ +# FastImage Example + +FastImage example app showing usage and comparing against `Image`. + +## Running FastImage Example + +```bash +git clone https://github.com/DylanVann/react-native-fast-image +cd react-native-fast-image +yarn + +# Starting the image server. +cd server +yarn +yarn start + +# In another terminal. + +# Starting the example app. +cd example +yarn +react-native run-ios +``` diff --git a/example/server/index.js b/server/index.js similarity index 100% rename from example/server/index.js rename to server/index.js diff --git a/example/server/package.json b/server/package.json similarity index 100% rename from example/server/package.json rename to server/package.json diff --git a/example/server/pictures/ahmed-saffu-235616.jpg b/server/pictures/ahmed-saffu-235616.jpg similarity index 100% rename from example/server/pictures/ahmed-saffu-235616.jpg rename to server/pictures/ahmed-saffu-235616.jpg diff --git a/example/server/pictures/alex-bertha-236361.jpg b/server/pictures/alex-bertha-236361.jpg similarity index 100% rename from example/server/pictures/alex-bertha-236361.jpg rename to server/pictures/alex-bertha-236361.jpg diff --git a/example/server/pictures/jaromir-kavan-233699.jpg b/server/pictures/jaromir-kavan-233699.jpg similarity index 100% rename from example/server/pictures/jaromir-kavan-233699.jpg rename to server/pictures/jaromir-kavan-233699.jpg diff --git a/example/server/pictures/martin-sanchez-143239.jpg b/server/pictures/martin-sanchez-143239.jpg similarity index 100% rename from example/server/pictures/martin-sanchez-143239.jpg rename to server/pictures/martin-sanchez-143239.jpg diff --git a/example/server/yarn.lock b/server/yarn.lock similarity index 100% rename from example/server/yarn.lock rename to server/yarn.lock