Skip to content

Commit

Permalink
Add badges of build and documentation statuses into README
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
kozalosev committed Oct 7, 2018
1 parent 4de0177 commit f9fb8d7
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
klocmod Kozalo's Localization Module
klocmod -- Kozalo's Localization Module
======================================

*Screw you, gettext! I don't wanna bother of compiling strings into binary files!*

[![Build Status](https://travis-ci.org/kozalosev/klocmod.svg?branch=master)](https://travis-ci.org/kozalosev/klocmod)
[![Documentation Status](https://readthedocs.org/projects/klocmod/badge/?version=latest)](https://klocmod.readthedocs.io/en/latest/?badge=latest)

This module provides a very simple, suboptimal way for localizing your scripts, bots or applications. The advantage is
its simplicity: to supply some sets of different string literals for different languages, you just need a simple JSON or
INI file (or even a dict) fed to the library. After that, the only thing you should take care of is to get an instance
Expand All @@ -11,7 +14,7 @@ of the dictionary for a specific language and extract messages from it by key va
All you mostly want is the `LocalizationsContainer` class. In particular, its static method
`LocalizationsContainer.from_file()` that reads a localization file and returns an instance of the factory. The factory
is supposed to produce instances of the `LanguageDictionary` class. Most likely, you will encounter instances of its
subclass the `SpecificLanguageDictionary` class (the base class is only used as a fallback that returns passed key
subclass -- the `SpecificLanguageDictionary` class (the base class is only used as a fallback that returns passed key
values back).

Examples of localization files
Expand Down

0 comments on commit f9fb8d7

Please sign in to comment.