iconmonstr-rails 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. data/.gitignore +6 -0
  2. data/README.md +55 -0
  3. metadata +79 -0
@@ -0,0 +1,6 @@
1
+ *.gem
2
+ .bundle
3
+ Gemfile.lock
4
+ pkg/*
5
+ bin
6
+ vendor/ruby
@@ -0,0 +1,55 @@
1
+ #Iconmonstr Rails
2
+ This little gem puts *all* the Iconmonstr icons into a webfont. Similar to FontAwesome. If you're planning on using this library with FontAwesome it may or may not play nicely, I haven't tested it thoroughly enough yet.
3
+
4
+ ## Getting Started
5
+
6
+ Put the following in the assets group within your Gemfile:
7
+
8
+ ```ruby
9
+ group :assets
10
+ gem 'iconmonstr-rails'
11
+ end
12
+ ```
13
+
14
+ Run the bundle install command to install the latest version.
15
+
16
+ `bundle install`
17
+
18
+
19
+ Include the stylesheet within your own
20
+
21
+ ```css
22
+ //= require 'iconmonstr'
23
+ ```
24
+
25
+ Remember there is a stylesheet for ie7 which you may want to include within your own ie7 styles.
26
+
27
+ ```css
28
+ //= require 'iconmonstr-ie7'
29
+ ```
30
+
31
+ ## Documentation
32
+ Go to iconmonstr.com and use their fantastic directory service to find the icon you're looking for. Currently the latest version of this rails gem only has all icons up to now (2012-11-10).
33
+
34
+ Find the icon you want to use in your project and make note of the URL slug. eg.
35
+
36
+ http://iconmonstr.com/share-icon/
37
+
38
+ Now to use this within your code use something like:
39
+
40
+ ```html
41
+ <i class="icon-share"></i>
42
+ ```
43
+
44
+ The general rule is to take the -icon and put it at the beginning of the URL slug. So
45
+
46
+ share-icon => icon-share
47
+ antenna-2-icon => icon-atenna-2
48
+
49
+ etc.
50
+
51
+ Just to keep with convention :)
52
+
53
+ ## License
54
+
55
+ Now I have been slightly out of order and re-packaged Iconmonstr's icons within font-faces in this gem. Please respect their rights and find the Iconmonstr license within the LICENSE file. I was just too desperate to have this within my projects!
metadata ADDED
@@ -0,0 +1,79 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: iconmonstr-rails
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Oliver Morgan
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2012-11-10 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: railties
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ! '>='
20
+ - !ruby/object:Gem::Version
21
+ version: 3.1.1
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ! '>='
28
+ - !ruby/object:Gem::Version
29
+ version: 3.1.1
30
+ - !ruby/object:Gem::Dependency
31
+ name: rails
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ! '>='
36
+ - !ruby/object:Gem::Version
37
+ version: 3.1.1
38
+ type: :runtime
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ! '>='
44
+ - !ruby/object:Gem::Version
45
+ version: 3.1.1
46
+ description: Iconmonstr, with assets pipeline, for Rails 3.1+
47
+ email:
48
+ - ollym@me.com
49
+ executables: []
50
+ extensions: []
51
+ extra_rdoc_files: []
52
+ files:
53
+ - .gitignore
54
+ - README.md
55
+ homepage: https://github.com/ollym/iconmonstr-rails
56
+ licenses: []
57
+ post_install_message:
58
+ rdoc_options: []
59
+ require_paths:
60
+ - lib
61
+ required_ruby_version: !ruby/object:Gem::Requirement
62
+ none: false
63
+ requirements:
64
+ - - ! '>='
65
+ - !ruby/object:Gem::Version
66
+ version: '0'
67
+ required_rubygems_version: !ruby/object:Gem::Requirement
68
+ none: false
69
+ requirements:
70
+ - - ! '>='
71
+ - !ruby/object:Gem::Version
72
+ version: '0'
73
+ requirements: []
74
+ rubyforge_project: iconmonstr-rails
75
+ rubygems_version: 1.8.24
76
+ signing_key:
77
+ specification_version: 3
78
+ summary: Iconmonstr for Rails
79
+ test_files: []