Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 9, 2020
1 parent 67df485 commit 7e7ff69
Show file tree
Hide file tree
Showing 4 changed files with 115 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ node_modules
*.env
.DS_Store
package-lock.json
.bloggify/*
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2018 Bloggify <[email protected]> (https://bloggify.org)
Copyright (c) 2018-20 Bloggify <[email protected]> (https://bloggify.org)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
115 changes: 112 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,41 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->








[![google-font-downloader](https://i.imgur.com/arpGZH6.png)](#)











# `$ google-font-downloader`

[![Version](https://img.shields.io/npm/v/google-font-downloader.svg)](https://www.npmjs.com/package/google-font-downloader) [![Downloads](https://img.shields.io/npm/dt/google-font-downloader.svg)](https://www.npmjs.com/package/google-font-downloader)







> Download Google fonts by providing the url





#### Usage


Expand All @@ -26,7 +53,18 @@ You need to provide the url to the Google APIs endpoint (e.g. `https://fonts.goo
- A file named `google-fonts-<timestamp>.css`—this will contain the CSS snippets that you need to copy in your app. You may need to update the paths to the font files.
- A directory structure looking like this: `fonts/<font-name>/<version>/<font-file>`

![Example](https://i.imgur.com/yGcOPKg.gif)
![](https://i.imgur.com/yGcOPKg.gif "Example")













## :cloud: Installation
Expand Down Expand Up @@ -56,25 +94,96 @@ Command arguments:
<url> The Google APIs url.
Options:
-v, --version Displays version information.
-h, --help Displays this help.
-v, --version Displays version information.
Examples:
$ google-font-downloader https://fonts.googleapis.com/css?family=Open+Sans:400,400i,700,700i
Documentation can be found at https://github.com/Bloggify/google-font-downloader#readme.
```






















## :question: Get Help

There are few ways to get help:



1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
















## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
























## :scroll: License

[MIT][license] © [Bloggify][website]

[license]: http://showalicense.com/?fullname=Bloggify%20%3Csupport%40bloggify.org%3E%20(https%3A%2F%2Fbloggify.org)&year=2018#license-mit





[license]: /LICENSE
[website]: https://bloggify.org
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@
}
]
}
}
}

0 comments on commit 7e7ff69

Please sign in to comment.