From fe38c452b553a20f35ce38fdfbd23f58f9069730 Mon Sep 17 00:00:00 2001 From: joe fleming Date: Fri, 31 Aug 2018 16:52:09 -0700 Subject: [PATCH] chore: update readmes --- README.md | 8 +++----- packages/scraper/README.md | 12 ++++++++++++ packages/search-site/README.md | 5 +++-- 3 files changed, 18 insertions(+), 7 deletions(-) create mode 100644 packages/scraper/README.md diff --git a/README.md b/README.md index 655114c..08367c4 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ -# strain-scraper +# strain-tools -scrapes strain info, stores for later reference. +![license](https://img.shields.io/badge/license-MIT-blue.svg) -[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/w33ble/strain-scraper/master/LICENSE) -[![npm](https://img.shields.io/npm/v/strain-scraper.svg)](https://www.npmjs.com/package/strain-scraper) -[![Project Status](https://img.shields.io/badge/status-experimental-orange.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index) +Monorepo for cannabis strain tools. For repos, check in `packages`. #### License diff --git a/packages/scraper/README.md b/packages/scraper/README.md new file mode 100644 index 0000000..7ff6990 --- /dev/null +++ b/packages/scraper/README.md @@ -0,0 +1,12 @@ +# leafly-scraper + +Scrapes strain info, stores for later reference. + +Clone repo and run the command. Resulting data can be found in `db.json`. + +``` +yarn install +yarn start +``` + +**NOTE**: You may need to run it multiple times (4 or 5 should do it), since some strains will get skipped the first few times. I don't know if it's leafly's endpoint or some weird race condition in the scraping code though. diff --git a/packages/search-site/README.md b/packages/search-site/README.md index 47ac217..ff0b5bf 100644 --- a/packages/search-site/README.md +++ b/packages/search-site/README.md @@ -1,9 +1,10 @@ # search-site -strain search static website. - ![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg) +Strain search static website. Use it to search for strains by name, effects, medical uses, and other tags. + +Based on data from leafly. You'll need to run the scraper first since that's where the data comes from. #### License