Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
@vbasky
vbasky committed Dec 14, 2020
1 parent 7994945 commit 37f8fbb
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .php_cs.cache
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"php":"7.4.13","version":"2.17.1","indent":" ","lineEnding":"\n","rules":{"array_syntax":{"syntax":"short"},"binary_operator_spaces":{"default":"single_space","operators":{"=>":null}},"blank_line_after_namespace":true,"blank_line_after_opening_tag":true,"blank_line_before_statement":{"statements":["return"]},"braces":true,"cast_spaces":true,"class_attributes_separation":{"elements":["method"]},"class_definition":true,"concat_space":{"spacing":"one"},"declare_equal_normalize":true,"elseif":true,"encoding":true,"full_opening_tag":true,"fully_qualified_strict_types":true,"function_declaration":true,"function_typehint_space":true,"heredoc_to_nowdoc":true,"include":true,"increment_style":{"style":"post"},"indentation_type":true,"linebreak_after_opening_tag":true,"line_ending":true,"lowercase_cast":true,"lowercase_constants":true,"lowercase_keywords":true,"lowercase_static_reference":true,"magic_method_casing":true,"magic_constant_casing":true,"method_argument_space":true,"native_function_casing":true,"no_alias_functions":true,"no_extra_blank_lines":{"tokens":["extra","throw","use","use_trait"]},"no_blank_lines_after_class_opening":true,"no_blank_lines_after_phpdoc":true,"no_closing_tag":true,"no_empty_phpdoc":true,"no_empty_statement":true,"no_leading_import_slash":true,"no_leading_namespace_whitespace":true,"no_mixed_echo_print":{"use":"echo"},"no_multiline_whitespace_around_double_arrow":true,"multiline_whitespace_before_semicolons":{"strategy":"no_multi_line"},"no_short_bool_cast":true,"no_singleline_whitespace_before_semicolons":true,"no_spaces_after_function_name":true,"no_spaces_around_offset":true,"no_spaces_inside_parenthesis":true,"no_trailing_comma_in_list_call":true,"no_trailing_comma_in_singleline_array":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"no_unneeded_control_parentheses":true,"no_unreachable_default_argument_value":true,"no_unused_imports":true,"no_useless_return":true,"no_whitespace_before_comma_in_array":true,"no_whitespace_in_blank_line":true,"normalize_index_brace":true,"not_operator_with_successor_space":true,"object_operator_without_whitespace":true,"ordered_imports":{"sortAlgorithm":"alpha"},"phpdoc_add_missing_param_annotation":{"only_untyped":false},"phpdoc_indent":true,"phpdoc_inline_tag":true,"phpdoc_no_access":true,"phpdoc_no_package":true,"phpdoc_no_useless_inheritdoc":true,"phpdoc_scalar":true,"phpdoc_single_line_var_spacing":true,"phpdoc_summary":true,"phpdoc_to_comment":true,"phpdoc_trim":true,"phpdoc_types":true,"phpdoc_var_without_name":true,"psr4":true,"self_accessor":true,"short_scalar_cast":true,"single_blank_line_at_eof":true,"single_blank_line_before_namespace":true,"single_class_element_per_statement":true,"single_import_per_statement":true,"single_line_after_imports":true,"single_line_comment_style":{"comment_types":["hash"]},"single_quote":true,"space_after_semicolon":true,"standardize_not_equals":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"ternary_operator_spaces":true,"trailing_comma_in_multiline_array":true,"trim_array_spaces":true,"unary_operator_spaces":true,"visibility_required":{"elements":["method","property"]},"whitespace_after_comma_in_array":true},"hashes":{"tests\/IndicScriptDravidianTest.php":4273130674,"tests\/IndicScriptITRANS.php":1064156754,"tests\/IndicScriptTransliterationTest.php":4128191048,"tests\/IndicSchemesDetectTest.php":1971476136,"tests\/IndicScriptToggleTest.php":2235055156,"tests\/IndicScriptSetupTest.php":4186787831,"tests\/IndicScriptOptionsTest.php":429645587,"tests\/IndicScriptBase.php":3431529934,"src\/IndicScriptFacade.php":4284080072,"src\/IndicSchemes.php":1742742615,"src\/IndicScript.php":2143057723,"src\/IndicScriptServiceProvider.php":2046227375}}
{"php":"7.4.13","version":"2.17.1","indent":" ","lineEnding":"\n","rules":{"array_syntax":{"syntax":"short"},"binary_operator_spaces":{"default":"single_space","operators":{"=>":null}},"blank_line_after_namespace":true,"blank_line_after_opening_tag":true,"blank_line_before_statement":{"statements":["return"]},"braces":true,"cast_spaces":true,"class_attributes_separation":{"elements":["method"]},"class_definition":true,"concat_space":{"spacing":"one"},"declare_equal_normalize":true,"elseif":true,"encoding":true,"full_opening_tag":true,"fully_qualified_strict_types":true,"function_declaration":true,"function_typehint_space":true,"heredoc_to_nowdoc":true,"include":true,"increment_style":{"style":"post"},"indentation_type":true,"linebreak_after_opening_tag":true,"line_ending":true,"lowercase_cast":true,"lowercase_constants":true,"lowercase_keywords":true,"lowercase_static_reference":true,"magic_method_casing":true,"magic_constant_casing":true,"method_argument_space":true,"native_function_casing":true,"no_alias_functions":true,"no_extra_blank_lines":{"tokens":["extra","throw","use","use_trait"]},"no_blank_lines_after_class_opening":true,"no_blank_lines_after_phpdoc":true,"no_closing_tag":true,"no_empty_phpdoc":true,"no_empty_statement":true,"no_leading_import_slash":true,"no_leading_namespace_whitespace":true,"no_mixed_echo_print":{"use":"echo"},"no_multiline_whitespace_around_double_arrow":true,"multiline_whitespace_before_semicolons":{"strategy":"no_multi_line"},"no_short_bool_cast":true,"no_singleline_whitespace_before_semicolons":true,"no_spaces_after_function_name":true,"no_spaces_around_offset":true,"no_spaces_inside_parenthesis":true,"no_trailing_comma_in_list_call":true,"no_trailing_comma_in_singleline_array":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"no_unneeded_control_parentheses":true,"no_unreachable_default_argument_value":true,"no_unused_imports":true,"no_useless_return":true,"no_whitespace_before_comma_in_array":true,"no_whitespace_in_blank_line":true,"normalize_index_brace":true,"not_operator_with_successor_space":true,"object_operator_without_whitespace":true,"ordered_imports":{"sortAlgorithm":"alpha"},"phpdoc_add_missing_param_annotation":{"only_untyped":false},"phpdoc_indent":true,"phpdoc_inline_tag":true,"phpdoc_no_access":true,"phpdoc_no_package":true,"phpdoc_no_useless_inheritdoc":true,"phpdoc_scalar":true,"phpdoc_single_line_var_spacing":true,"phpdoc_summary":true,"phpdoc_to_comment":true,"phpdoc_trim":true,"phpdoc_types":true,"phpdoc_var_without_name":true,"psr4":true,"self_accessor":true,"short_scalar_cast":true,"single_blank_line_at_eof":true,"single_blank_line_before_namespace":true,"single_class_element_per_statement":true,"single_import_per_statement":true,"single_line_after_imports":true,"single_line_comment_style":{"comment_types":["hash"]},"single_quote":true,"space_after_semicolon":true,"standardize_not_equals":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"ternary_operator_spaces":true,"trailing_comma_in_multiline_array":true,"trim_array_spaces":true,"unary_operator_spaces":true,"visibility_required":{"elements":["method","property"]},"whitespace_after_comma_in_array":true},"hashes":{"tests\/IndicScriptDravidianTest.php":1132409846,"tests\/IndicScriptITRANS.php":2516405183,"tests\/IndicScriptTransliterationTest.php":1730589830,"tests\/IndicSchemesDetectTest.php":2984407204,"tests\/IndicScriptToggleTest.php":3183670330,"tests\/IndicScriptSetupTest.php":1515005553,"tests\/IndicScriptOptionsTest.php":3134786312,"tests\/IndicScriptBase.php":3596741811,"src\/IndicScriptFacade.php":4284080072,"src\/IndicSchemes.php":1742742615,"src\/IndicScript.php":2143057723,"src\/IndicScriptServiceProvider.php":2046227375,"src\/Facades\/IndicScript.php":3615585633,"src\/Script\/IndicSchemes.php":1742742615,"src\/Script\/IndicScriptServiceProvider.php":2046227375,"src\/Script\/IndicScript.php":2143057723}}
9 changes: 6 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ IndicScript is a transliteration library for Indian languages written in PHP. It

## Requirements

IndicScript requires PHP 5.4.8 and up though its only been tested on PHP 7. PHP versions before 5.4.8 have a version of `mb_substr()` that is known to be [broken](http://us.php.net/ChangeLog-5.php). These versions will not work with IndicScript.
IndicScript requires PHP 7.4

## Usage

Expand Down Expand Up @@ -43,7 +43,7 @@ In Laravel 5.5 the package's service provider and facade will be registered auto

'aliases' => [
...
'IndicScript' => Sanskritick\Script\IndicScriptFacade::class,
'IndicScript' => Sanskritick\Facades\IndicScript::class,
],
```

Expand All @@ -53,7 +53,10 @@ The facade is optional, but the rest of this guide assumes you're using it.

```php
<?php
$output = IndicScript::t($input, $from, $to);

use Sanskritick\Facades\IndicScript;

$output = IndicScript::transliterate($input, $from, $to);
```

Here, `$from` and `$to` are the names of different **schemes**. In IndicScript, the word "scheme" refers to both scripts and romanizations. These schemes are of two types:
Expand Down
1 change: 0 additions & 1 deletion src/Script/IndicScriptServiceProvider.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
namespace Sanskritick\Script;

use Illuminate\Support\ServiceProvider;
use Sanskritick\Script\IndicScript;

class IndicScriptServiceProvider extends ServiceProvider
{
Expand Down

0 comments on commit 37f8fbb

Please sign in to comment.