diff --git a/.assets/govicons-logo.svg b/.assets/govicons-logo.svg new file mode 100644 index 0000000..169f954 --- /dev/null +++ b/.assets/govicons-logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..8a46391 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,26 @@ +## Expected behavior + + + +## Actual behavior + + + +## What version are you using? + +Version: +Browser and version: + +## Steps to reproduce + + + +## Bug report checklist + +- [ ] I have filled out as much of the above information as I can +- [ ] I have included a test case because my odds go _way_ up that the team can fix this when I do +- [ ] I have [searched for existing issues](https://github.com/540co/govicons/issues) and to the best of my knowledge this is not a duplicate diff --git a/.github/ISSUE_TEMPLATE/icon-request.md b/.github/ISSUE_TEMPLATE/icon-request.md new file mode 100644 index 0000000..ad30a70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/icon-request.md @@ -0,0 +1,13 @@ +## What can it be used for? + + + +## Example image (optional) + + + +## Icon request checklist + +- [ ] The title starts with "Icon request: " and is followed by the requested icon name (Ex: `Icon request: hipster-coder`) +- [ ] I have [searched for existing issues](https://github.com/540co/govicons/issues) and to the best of my knowledge this is not a duplicate +- [ ] I have included at least one example image if it could be helpful (optional) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..b4a74bb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ + + + +## Reference to issue + + +## Description + + +## Mentions + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b2dc6a4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing to Gov Icons + +If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github. + +## Quick start + +We only accept issues that are icon requests, bug reports, or feature requests. +Bugs must be isolated and reproducible problems that we can fix within the Gov Icons framework. + +* [Request a new icon](https://github.com/540co/govicons/issues/new?title=Icon%20request:%20icon-name&template=icon-request.md) +* [Submit a bug report](https://github.com/540co/govicons/issues/new?template=bug-report.md) + +## Requesting new icons + +- Title your new issue Icon request: icon-name (e.g., Icon request: icon-drone). +- Include a few use cases for your requested icon. How do you plan on using it? + +## Key branches + +- `master` is the latest, deployed version + +## Pull requests + +- At the moment we are not accepting pull requests containing icons +- Try to share which browsers your code has been tested in before submitting a pull request diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..f140819 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,3 @@ +- Gov Icons licensed under [SIL OFL 1.1](http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL) +- Code licensed under [MIT License](http://opensource.org/licenses/mit-license.html) +- Documentation licensed under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/) diff --git a/README.md b/README.md index 70aaa8c..7ed1943 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ -## Gov Icons +
A Government font and CSS toolkit, inspired by Font-Awesome.
+ +--- Gov Icons is a icon font and CSS toolkit with 129 government themed icons, for easy scalable vector graphics on projects that needs government based icons. Gov Icons is created and maintained by [540](http://540.co). @@ -37,13 +43,7 @@ Get started and learn how to use Gov Icons at