crowdfree/library/README.md

A crowdin compatible tool for translation and localisation of websites and applications

# Translation library

This is a library to use crowdfree compatible translations in your javascript project.

## Basic usage

```Javascript
const Crowdfree = require("crowdfree")
const cf = new Crowdfree()
cf.load("./path/to/locale") // Locale files will be loaded with require()

console.log(cf.t(
    "welcome_message", // Name of locale string
    {
        _: "Hello, this is the default welcome message for %{programName}", // _ denotes the default shown when no locale is found. %{} is used for substitution and should be included in translated versions as well
        programName: "Crowdfree library example program" // Value for substitution
    }
))
console.log(cf.t("more_usage_information")) // Basic usage
```