Skip to content

Commit af904c9

Browse files
NathanWalkerfilipesilva
authored andcommitted
chore(docs): correct grammer, minor improvements
Close #179
1 parent f751830 commit af904c9

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The generated project has dependencies that require **Node 4 or greater**.
3131
* [Installing a 3rd Party Library](#installing-a-3rd-party-library)
3232
* [Running Unit Tests](#running-unit-tests)
3333
* [Running End-to-End Tests](#running-end-to-end-tests)
34-
* [Deploying the App via GitHub Pages](#deploying-the-app-via-gitHub-pages)
34+
* [Deploying the App via GitHub Pages](#deploying-the-app-via-github-pages)
3535
* [Known Issues](#known-issues)
3636

3737
## Installation

docs/ng-install.md

+13-9
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,11 @@
99

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

12-
How do I find this out?
12+
How do I find that out?
1313

14-
1. Find the root file in the 3rd party library repo you are interested in
15-
2. Take a look at the root file (should be the same name as the repo itself in most cases)
16-
3. If you see `export default { ...some angular2 metadata... }` at the bottom, then the chances are high it's compatible
17-
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
14+
1. Look inside the root file of the 3rd party library repo (should be the same name as the repo itself in most cases)
15+
2. If you see `export default { ...some angular2 metadata... }` at the bottom, then the chances are high it's compatible
16+
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
1817

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

@@ -63,14 +62,13 @@ Providers imported in ~/project/src/app.ts
6362
Done.
6463
```
6564

66-
You library is now successfully installed and injected into your project.
65+
Your library is now successfully installed and injected into your project.
6766

6867
In this example we chose to inject a `Directive`.
6968
Specifically we chose `TestDirective` to be injected into `~/project/src/app/project.ts`.
7069
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.
7170

72-
However, if we don't want that the library to auto-inject anything, we can just answer `N(o)` to the first question.
73-
71+
However, if you don't want to auto-inject anything, you can just answer `N(o)` to the first question.
7472
Example:
7573

7674
````shell
@@ -145,6 +143,12 @@ builder
145143
````
146144

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

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

@@ -174,7 +178,7 @@ export * from './src/app/test.styles';
174178
175179
// This is the magic.
176180
// Provides a standard way to export your library to allow angular-cli to help developers setup your library
177-
// Please note: keys are optional. Your library can provide any metadata is provides.
181+
// Please note: keys are optional. Your library should provide any metadata you want to be consumable.
178182
export default {
179183
directives: [TestDirective],
180184
pipes: [TestPipe],

0 commit comments

Comments
 (0)