Updated readme

This commit is contained in:
Daniel Winzen
2020-10-17 10:10:58 +02:00
parent 785bd9c2a4
commit c7aeb9fa79
2 changed files with 10 additions and 41 deletions

26
README
View File

@ -1,26 +0,0 @@
GENERAL INFORMATION:
This is a set of script to run a hit counter, specifically designed for TOR hidden services. An up-to-date copy can be downloaded at https://github.com/DanWin/hit-counter
INSTALLATION INSTRUCTIONS:
You'll need to have php with pdo_mysql, pcre and date extension, a web-server and a MySQL server installed.
When you have everything installed, you'll have to create a database and a user for the scripts.
Then edit the configuration in counter_config.php to reflect the appropriate database settings and to modify the settings the way you like them.
Then copy the scripts to your web-server directory and open the setup.php script like this: http://(server)/setup.php
Note: If you updated the script, please visit http://(server)/setup.php again, to make sure, that any database changes are applied and no errors occure.
TRANSLATING:
Copy counter_lang_en.php and rename it to counter_lang_YOUR_LANGCODE.php
Then edit the file and translate the messages into your language and change $I to $T at the top.
If you ever use a ' character, you have to escape it by using \' instead or the script will fail.
When you are done, you have to edit counter_config.php, to include your translation. Simply add a line with
'lang_code' => 'Language name',
to the $L array below the settings, similar to what I did for the German translation.
Please share your translation with me, so I can add it to the official version.
To update your translation, you can copy each new string to your translation file or edit the automated lang_update.php script to reflect you language and run it.
LIVE DEMO:
If you want to see the scripts in action, you can visit my TOR hidden service http://tt3j2x4k5ycaa5zt.onion/counter_reg.php or via my clearnet proxy https://danwin1210.me/counter_reg.php if you don't have TOR installed.

View File

@ -1,30 +1,25 @@
General information:
--------------------
This is a set of script to run a hit counter, specifically designed for TOR hidden services. An up-to-date copy can be downloaded at https://github.com/DanWin/hit-counter
This is a set of script to run a hit counter, specifically designed for Tor hidden services. An up-to-date copy can be downloaded at https://github.com/DanWin/hit-counter
Installation instructions:
--------------------------
You'll need to have php with pdo_mysql, pcre and date extension, a web-server and a MySQL server installed.
When you have everything installed, you'll have to create a database and a user for the scripts.
Then edit the configuration in counter_config.php to reflect the appropriate database settings and to modify the settings the way you like them.
Then copy the scripts to your web-server directory and open the setup.php script like this: http://(server)/setup.php
Note: If you updated the script, please visit http://(server)/setup.php again, to make sure, that any database changes are applied and no errors occure.
Then edit the configuration in `counter_config.php` to reflect the appropriate database settings and to modify the settings the way you like them.
Then copy the scripts to your web-server directory and open the `setup.php` script like this: `http://(server)/setup.php`
Note: If you updated the script, please visit `http://(server)/setup.php` again, to make sure, that any database changes are applied and no errors occur.
Translating:
------------
Copy counter_lang_en.php and rename it to counter_lang_YOUR_LANGCODE.php
Then edit the file and translate the messages into your language and change $I to $T at the top.
If you ever use a ' character, you have to escape it by using \' instead or the script will fail.
Copy `counter_lang_en.php` and rename it to `counter_lang_YOUR_LANGCODE.php`
Then edit the file and translate the messages into your language and change `$I` to `$T` at the top.
If you ever use a ' character, you have to escape it by using \' instead, or the script will fail.
When you are done, you have to edit counter_config.php, to include your translation. Simply add a line with
```'lang_code' => 'Language name',```
to the $L array below the settings, similar to what I did for the German translation.
`'lang_code' => 'Language name',`
to the `$L` array below the settings, similar to what I did for the German translation.
Please share your translation with me, so I can add it to the official version.
To update your translation, you can copy each new string to your translation file or edit the automated lang_update.php script to reflect you language and run it.
Live Demo:
----------
If you want to see the scripts in action, you can visit my TOR hidden service http://tt3j2x4k5ycaa5zt.onion/counter_reg.php or via my clearnet proxy https://danwin1210.me/counter_reg.php if you don't have TOR installed.
To update your translation, you can copy each new string to your translation file or edit the automated `lang_update.php` script to reflect you language and run it.