Skip to content

chore(docs): correct grammer, minor improvements #179

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The generated project has dependencies that require **Node 4 or greater**.
* [Installing a 3rd Party Library](#installing-a-3rd-party-library)
* [Running Unit Tests](#running-unit-tests)
* [Running End-to-End Tests](#running-end-to-end-tests)
* [Deploying the App via GitHub Pages](#deploying-the-app-via-gitHub-pages)
* [Deploying the App via GitHub Pages](#deploying-the-app-via-github-pages)
* [Known Issues](#known-issues)

## Installation
Expand Down
22 changes: 13 additions & 9 deletions docs/ng-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@

Prerequisites: **You will first want to make sure the library adheres to the Publisher Guide**

How do I find this out?
How do I find that out?

1. Find the root file in the 3rd party library repo you are interested in
2. Take a look at the root file (should be the same name as the repo itself in most cases)
3. If you see `export default { ...some angular2 metadata... }` at the bottom, then the chances are high it's compatible
4. If you don't see it, [click here](#suggest-a-repo-adhere-to-the-publisher-guide) to copy/paste a feature request to post on the library repo
1. Look inside the root file of the 3rd party library repo (should be the same name as the repo itself in most cases)
2. If you see `export default { ...some angular2 metadata... }` at the bottom, then the chances are high it's compatible
3. If you don't see it, [click here](#suggest-a-repo-adhere-to-the-publisher-guide) to copy/paste a feature request to post on the library repo

### Ok I'm ready, let's do this!

Expand Down Expand Up @@ -63,14 +62,13 @@ Providers imported in ~/project/src/app.ts
Done.
```

You library is now successfully installed and injected into your project.
Your library is now successfully installed and injected into your project.

In this example we chose to inject a `Directive`.
Specifically we chose `TestDirective` to be injected into `~/project/src/app/project.ts`.
Upon quitting, we were given the opportunity to inject providers into our bootstrap script. We chose `Y(es)` and specified `~/project/src/app.ts`. Providers were then injected into our bootstrap script.

However, if we don't want that the library to auto-inject anything, we can just answer `N(o)` to the first question.

However, if you don't want to auto-inject anything, you can just answer `N(o)` to the first question.
Example:

````shell
Expand Down Expand Up @@ -145,6 +143,12 @@ builder
````

Just include this script in the root of your app named like `bundler-script.js` and run it before publishing your library to `npm`.
Example of a `prepublish` script in `package.json`:
```
"scripts": {
"prepublish": "tsc && tsc -d && node bundler-script.js"
}
```

Note that when TypeScript version 1.8 is out of `beta`, this script will no longer be needed and this documentation will be updated.

Expand Down Expand Up @@ -174,7 +178,7 @@ export * from './src/app/test.styles';

// This is the magic.
// Provides a standard way to export your library to allow angular-cli to help developers setup your library
// Please note: keys are optional. Your library can provide any metadata is provides.
// Please note: keys are optional. Your library should provide any metadata you want to be consumable.
export default {
directives: [TestDirective],
pipes: [TestPipe],
Expand Down