Documentation for polymer 2.x (Fixes #1) #10
Conversation
|
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed (or fixed any issues), please reply here (e.g. What to do if you already signed the CLAIndividual signers
Corporate signers
|
|
I signed it! |
|
CLAs look good, thanks! |
README.md
Outdated
|
|
||
| ## Usage in a Polymer 2.x Application | ||
|
|
||
| Add the following line to the end of your `bower.json` |
There was a problem hiding this comment.
Is this accurate? IINM, the line needs to go into the dependencies section specifically, and this would normally be done using a bower install --save command...yes, this seems to work for me:
$ bower install --save 'font-roboto=PolymerElements/font-roboto-local#^1.1.0'
There was a problem hiding this comment.
You are right. I failed to mention that the line goes into the dependencies section. Should I create another pull request?
There was a problem hiding this comment.
I have no authority here, so it's up to you. I'd probably just force push to your existing branch, but anyway, I hope you don't think I have permissions to merge this since I don't... :/
There was a problem hiding this comment.
Alright. Thanks. Let's wait for someone with authority to merge it.
At least someone wanting to using roboto locally will eventually find this pull request and this discussion. :D
There was a problem hiding this comment.
You don't need to create another PR, you can just add another commit to this one (locally just do a git commit -am "your new message"; git push. You don't have to force push either, i can squash the commits if we merge this.
I agree with @davidmaxwaterman that your line is incorrect. I would prefer something like:
To add this to your application, run this command from your project root directory:
bower install --save 'font-roboto=PolymerElements/font-roboto-local#^1.1.0'
This will add and install the dependency to your project. Then, you can import the file and use the font in your page:
<head>
...
<link rel="import" href="roboto.html">
<style>
.roboto {
font-family: Roboto
}
</style>
</head>
<body>
...
<div class="roboto">This is using Roboto!</div>
</body>
...There was a problem hiding this comment.
@notwaldorf Thank you. I've made the changes required.
README.md
Outdated
|
|
||
| ## Usage in a Polymer 2.x Application | ||
|
|
||
| Add the following line to the end of your `bower.json` |
There was a problem hiding this comment.
You don't need to create another PR, you can just add another commit to this one (locally just do a git commit -am "your new message"; git push. You don't have to force push either, i can squash the commits if we merge this.
I agree with @davidmaxwaterman that your line is incorrect. I would prefer something like:
To add this to your application, run this command from your project root directory:
bower install --save 'font-roboto=PolymerElements/font-roboto-local#^1.1.0'
This will add and install the dependency to your project. Then, you can import the file and use the font in your page:
<head>
...
<link rel="import" href="roboto.html">
<style>
.roboto {
font-family: Roboto
}
</style>
</head>
<body>
...
<div class="roboto">This is using Roboto!</div>
</body>
...
| @@ -4,3 +4,37 @@ A version of [font-roboto](https://github.com/PolymerElements/font-roboto) using | |||
| locally available font files | |||
|
|
|||
| The font files are subject to the Apache License found here: https://github.com/google/fonts/blob/master/apache/roboto/LICENSE.txt | |||
|
|
|||
| ## Usage in a Polymer 2.x Application | |||
There was a problem hiding this comment.
I think we can change this to just "How to use", since it applies to both 1.x and 2.x apps
| ... | ||
| ``` | ||
|
|
||
| If you are using polymer CLI to build your app then add the following to your `polymer.json`'s `extraDependencies` array. |
There was a problem hiding this comment.
typo: s/using polymer CLI/the Polymer CLI
There was a problem hiding this comment.
You're a vi user "wannabe", I see :)
:s/using polymer CLI/using the Polymer CLI/
No description provided.