Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(readme): add ref to the igniteui-angular repo #13

Merged
merged 5 commits into from
Oct 23, 2018
Merged

Conversation

Aleksandyr
Copy link
Contributor

No description provided.

@Aleksandyr Aleksandyr requested a review from zdrawku October 23, 2018 05:38
README.md Outdated
@@ -1,6 +1,9 @@
## typedoc-plugin-localization
[![Build Status](https://travis-ci.org/IgniteUI/typedoc-plugin-localization.svg?branch=master)](https://travis-ci.org/IgniteUI/typedoc-plugin-localization)
[![npm version](https://badge.fury.io/js/typedoc-plugin-localization.svg)](https://badge.fury.io/js/typedoc-plugin-localization)

## Inspired by [igniteui-angular](https://github.com/IgniteUI/igniteui-angular)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Inspired by [igniteui-angular](https://github.com/IgniteUI/igniteui-angular)
## Inspired and used by [Ignite UI for Angular](https://github.com/IgniteUI/igniteui-angular)

README.md Outdated

#### Additional Information

We have exposed the opportunity to localize your hardcoded template strings. How? </br>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We have exposed the opportunity to localize your hardcoded template strings. How? </br>
For your convenience we have exposed a way to localize your hardcoded template strings. How? </br>

README.md Outdated
</ul>
```

3. Execute the translation command which would contains the `localization key` and the `path` to the `template strings` file. </br>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. Execute the translation command which would contains the `localization key` and the `path` to the `template strings` file. </br>
3. Execute the translation command which would contain the `localization key` and the `path` of the `template strings` file. </br>

README.md Outdated
```
npx typedoc `<main-proj-dir>` --localize `<localization-key>` --templateStrings <path/to/the/file>`
```
In the case of the [igniteui-angular](https://github.com/IgniteUI/igniteui-angular) it would be:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In the case of the [igniteui-angular](https://github.com/IgniteUI/igniteui-angular) it would be:
In case of [igniteui-angular](https://github.com/IgniteUI/igniteui-angular) it would be:

@zdrawku zdrawku merged commit 483790b into master Oct 23, 2018
@zdrawku zdrawku deleted the update-readme branch October 23, 2018 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants