Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    web-literacy-clientpublic

    Web Literacy Client

    This is a utility to map each version of the Web Literacy Map to a set of machine-readable tags.

    The goal of this repository is to:

    • Store version history for the map with tags
    • Provide localized versions of each tag via Transifex
    • Provide translations for deprecated tags in older versions of the map by mapping them to new literacies
    • Provide support for applications using i18n that need to use the Web literacy Map

    Creating a new version

    1. Edit src/weblitmap.json. Make sure you update the version number.
    2. Run npm install, and then grunt generate. This will create dist/weblitmap_strings.{{version}}.json, a Transifex-compatible file.
    3. Commit your changes and tag your release with npm version {{version}}.

    Downloading new locales

    1. Run grunt build
    2. Your files will get downloaded from Transifex and dist/web-literacy-client.with-langs.js will be generated. Hurray!

    Integrating the Web Literacy Map with your localized app

    TODO: Including locale/ json files

    Using the web literacy client in the browser

    bower install web-literacy-client
    var wlc = new WebLiteracyClient();
    wlc.lang('fr');
    wlc.all();
    wlc.term(someTag);
    wlc.description(someTag);
    

    Using the web literacy client in node

    npm install web-literacy-client
    var WebLiteracyClient = require('web-literacy-client');
    var wlc = new WebLiteracyClient();
    wlc.lang('fr');
    wlc.all();
    wlc.term(someTag);
    wlc.description(someTag);
    

    Tests and Examples

    bower install to install quint and example dependencies. See tests/ to run unit tests. See examples/ for a node and browser example.

    Keywords

    none

    install

    npm i web-literacy-client

    Downloadsweekly downloads

    9

    version

    1.1.1

    license

    MIT

    homepage

    github.com

    last publish

    collaborators

    • avatar