Skip to content

Commit

Permalink
Add README and remove schema locales for now
Browse files Browse the repository at this point in the history
  • Loading branch information
t-kelly committed Dec 21, 2023
1 parent 1da053b commit b338c83
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 36,379 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Ecommerce Locales Library

E-commerce websites, like those powered by Shopify themes, contain strings of text like "Add to cart" or "Continue shopping". If you want your website to be accessible in multiple languages, those strings need to be translated. Why should you do the work of translating strings that have already been translated!?

Introducing the Archetype Themes Locales repo, your (open) source for all of your e-commerce translations! Instead of translating the same strings over and over again in private silos, let's pool translations into one place so we can all benefit!

### How to use

Using these translations is as easy as:

1. **Copy the JSON files, in their entirety, into your latest theme project.** There is no penalty to having extra translations included in your theme.
2. **Use the [Locales Detective](https://archetype-themes.github.io/locales/) to find a translation you need.** You can search this repo or [shopify/dawn](https://github.com/Shopify/dawn) and you can select your search input language.
3. **Use the copy button to copy the Liquid** (e.g. `{{ add_to_cart | t }}`) to your clipboard and paste into your theme!

As a bonus, the copy button can even handle translations with [interpolations](https://shopify.dev/docs/themes/architecture/locales/storefront-locale-files#interpolation). So a translation like `"You save {{ saved_amount }}"` will generate Liquid like `{{ 'you_save_amount' | t: saved_amount: "[saved_amount]" }}`!

### Contribute your translations

Have some translations that are missing from the repo? Spotted a translation that could be improved? Please open a pull-request and contribute!

Here are a few things to keep in mind:

- This is an English centric library and the `en.default.json` will act as the source of truth for translations keys and values.
- A new proposed translation should always include an English version inside of `en.default.json`
Loading

0 comments on commit b338c83

Please sign in to comment.