Add readme and example xhtml-file

README.md

@@ -0,0 +1,19 @@
+# tal-i18n-extract
+
+[![Unittests](https://github.com/usox/tal-i18n-extract/actions/workflows/php.yml/badge.svg)](https://github.com/usox/tal-i18n-extract/actions/workflows/php.yml)
+
+Extract translation keys out of [PHPTAL](https://github.com/phptal/PHPTAL) templates.
+
+This is a php port of the [I18NFool](https://metacpan.org/dist/I18NFool) CPAN perl-package.
+
+## Usage
+
+```php
+./bin/tal-i18n-extract path-to-file(s).xhtml
+```
+
+All found translation keys will be printed out POT-formatted.
+
+## Beware
+
+All templates must contain valid xml and have to define the i18n-namespace (see example).

example/example.xhtml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<root xmlns:i18n="http://xml.zope.org/namespaces/i18n">
+    <div i18n:translate="">Some string</div>
+    <div i18n:translate="">Some string with <span i18n:name="placeholder">what?!</span></div>
+    <div i18n:translate="translation-key">Some string with pre-defined translation-key</div>
+    <div title="Some title-attribute" i18n:attributes="title">...</div>
+    <div title="Some title-attribute" i18n:attributes="title pre-defined-attribute-translation-key">...</div>
+</root>

src/Io/FileLoader.php

@@ -7,7 +7,6 @@
 use DOMDocument;
 use DOMXPath;
 use Generator;
-use Usox\TalI18nExtract\ExtractorDecorator;
 
 /**
  * Gets file-paths and returns fully-loaded XPath-objects one-by-one

tests/Io/FileLoaderTest.php

@@ -43,7 +43,7 @@ public function testReadFailsIfFileDoesNotExist(): void
 
     public function testReadFailsIfFileIsNotReadable(): void
     {
-        $file = new vfsStreamFile('snafu', 0000);
+        $file = new vfsStreamFile('snafu', 0o000);
 
         $this->vfsStream->addChild($file);