License, Readme

Author: alexleclair

.env.example

@@ -0,0 +1,5 @@
+SHOPIFY_LOCALE=fr
+SHOPIFY_LANGIFY_ID=ly12345
+SHOPIFY_STORE=your-store
+SHOPIFY_API_KEY=CHANGEME
+SHOPIFY_API_PASSWORD=CHANGEME

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 213a Studio Créatif, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,45 @@
+# Shopify Langify V1 to Native Translations
+This tool makes it easy to port over a store's langify v1 data to Shopify's native tooling.
+
+## What it supports
+With this tool, you can port over the following resources:
+- Products 
+- Smart Collections
+- Custom Collections 
+- Articles
+- Pages
+
+## Setting it all up
+You'll first need to [create a private app](https://help.shopify.com/en/manual/apps/private-apps#generate-credentials-from-the-shopify-admin "Read Shopify's documentation on how to create a private app"). It needs write access to the store.
+
+Here are the access scopes that will be required:
+- Store content like articles, blogs, comments, pages, and redirects
+- Products, variants and collections
+
+Then, you will need to create a `.env` file (copy it from `.env.example`) and fill it out with the right api information you will have gathered from the private apps process.
+Alternatively, you can simply pass your store, key, password, langify id and locale through command-line arguments.
+
+## Usage
+###  Available flags
+
+- `--products` ports over all products' translations
+- `--collections` ports over collections' translations
+- `--pages` ports over pages' translations
+- `--articles` ports over articles' translations
+- `--all` will port over everything.
+
+
+### Examples
+
+- Porting only product: run `yarn start --products`
+- Porting only pages: run `yarn start --pages`
+- Porting only articles: run `yarn start --articles`
+- Porting products & articles: run `yarn start --products --articles`
+- Porting products, pages & articles: run `yarn start --products --articles --pages`
+- Just port everything you can: run `yarn start --all`
+
+## Issues and bugs
+Create a new issue, or issue a new PR on this repo if you've found an issue and would like it fixed.
+
+## License 
+MIT. Do whatever you like with this stuff ✌️.