Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wapmorgan committed Jan 28, 2017
1 parent b749ed9 commit 97de456
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@ Supported languages:

# Declension

### Personal names
## Russian

##### Declension of first names in russian language:
### First names
Declension of first names in russian language:

1. Create declension class object:
```php
Expand Down Expand Up @@ -65,7 +66,8 @@ Supported languages:
var_dump($dec->getForm('Иван', RussianCases::RODIT, RussianNamesDeclension::MAN)); // Ивана
```

##### Declension of last names in russian language:
### Last names
Declension of last names in russian language:

1. Create declension class object:
```php
Expand Down Expand Up @@ -107,8 +109,7 @@ Supported languages:
```

### General words

##### Declension of general words in russian language:
Declension of general words in russian language:

1. Create declension class object:
```php
Expand Down Expand Up @@ -212,13 +213,13 @@ Supported languages:

## Contributing / Addition of new languages.

Morphos are open for additions and improvements.
`Morphos` are open for additions and improvements.

Addition a new language is simple: create the class inheriting one of basic classes and realize abstract methods from it.

Here is a list of basic classes:

- `BasicNamesDeclension`
#### BasicNamesDeclension

Class for names declension.

Expand All @@ -237,7 +238,7 @@ Class for names declension.
abstract public function getForm($name, $form, $gender);
```

- `BasicDeclension`
#### BasicDeclension

* Checks, whether there are rules for this word.
```php
Expand All @@ -254,7 +255,7 @@ Class for names declension.
public function getForm($word, $form, $animate = false);
```

#### Useful functions in morphos namespace
### Useful functions in morphos namespace

For simple access to functions of string processing there are some functions in `morphos` namespace:

Expand Down

0 comments on commit 97de456

Please sign in to comment.