From 7e7ff69b057cc2824a2d7ff1a0327a50f232f87d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Sun, 9 Aug 2020 21:49:49 +0300 Subject: [PATCH] Updated docs --- .gitignore | 1 + LICENSE | 2 +- README.md | 115 +++++++++++++++++++++++++++++++++++++++++++++++++-- package.json | 2 +- 4 files changed, 115 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index af96bda..2ca2591 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ node_modules *.env .DS_Store package-lock.json +.bloggify/* diff --git a/LICENSE b/LICENSE index 9811d05..7164b2f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2018 Bloggify (https://bloggify.org) +Copyright (c) 2018-20 Bloggify (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 diff --git a/README.md b/README.md index 96ce41c..aab8ab0 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,41 @@ + + + + + + [![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 @@ -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-.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///` -![Example](https://i.imgur.com/yGcOPKg.gif) +![](https://i.imgur.com/yGcOPKg.gif "Example") + + + + + + + + + + + ## :cloud: Installation @@ -56,8 +94,8 @@ Command arguments: 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 @@ -65,16 +103,87 @@ Examples: 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 diff --git a/package.json b/package.json index 06db841..7f8a49c 100644 --- a/package.json +++ b/package.json @@ -82,4 +82,4 @@ } ] } -} \ No newline at end of file +}