Skip to content

Commit

Permalink
docs: fix readme links after rename
Browse files Browse the repository at this point in the history
  • Loading branch information
aaltat committed Sep 18, 2024
1 parent 5f111a2 commit 6d4661f
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,23 @@

This project contains a transations for the Robot Framework
[Browser](https://github.com/MarketSquare/robotframework-browser)
libary. Currently project contais only one translation, Finnish, but
new languages can be added by creating translation_xx.json file
libary. Currently project contais only one translation,
[Finnish](https://github.com/MarketSquare/robotframework-browser-translation/blob/main/robotframework_browser_translation/translation_fi.json)
, but new languages can be added by creating translation_xx.json file
and adding the file to
[__init__.py](https://github.com/MarketSquare/robotframework-browser-translation-fi/blob/main/robotframework_browser_translation_fi/translation_fi.json) file.
[__init__.py](https://github.com/MarketSquare/robotframework-browser-translation/blob/main/robotframework_browser_translation/__init__.py) file.

This project uses Browser library
[Python plugin API](https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/)
to provide
[translation.json](https://github.com/MarketSquare/robotframework-browser-translation-fi/blob/main/robotframework_browser_translation_fi/translation_fi.json)
[translation_xx.json](https://github.com/MarketSquare/robotframework-browser-translation/blob/main/robotframework_browser_translation/translation_fi.json)
file for the Browser library. Browser library searches Python plugins by using
naming convention: `robotframework_browser_translation`. This module
fulfils the Browser library translation API and provides `get_language`
metghod. The method return a list of dictionries:

```Python
{"language": "fi", "path": "/opath/to/translation.json")}
```python
[{"language": "fi", "path": "/path/to/translation.json"}]
```
Which Browser library will use to match correct translation from all
the found Python plugins. Languea search is enabled when Browser
Expand All @@ -35,7 +36,7 @@ Library Browser languege=fi

## Detect changes in documentation
The
[translation.json](https://github.com/MarketSquare/robotframework-browser-translation-fi/blob/main/robotframework_browser_translation_fi/translation.json)
[translation_xx.json](https://github.com/MarketSquare/robotframework-browser-translation/blob/main/robotframework_browser_translation/translation_fi.json)
contains sha256 sum, which is generated by the Browser library. The sha256
is the checksum of the original documentation of the Browser library documentation.
The checksum is used by
Expand Down

0 comments on commit 6d4661f

Please sign in to comment.