Skip to content
This repository was archived by the owner on Dec 14, 2018. It is now read-only.

Commit 8a4b7c2

Browse files
committed
Improvements to README.
1 parent 26476cc commit 8a4b7c2

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ demonstration purposes only and does not apply to this software.
4747

4848
4. Customize `bower.json`.
4949

50-
5. Replace the placeholder package name.
50+
5. Replace any remaining instances of the placeholder package name.
5151
You can replace the placeholder package name with your own using
5252

5353
````bash
@@ -93,6 +93,18 @@ $ git checkout -b sass-package upstream/master
9393

9494
## Installation
9595

96+
The recommended method is to add this as a dependency
97+
to your project using [Bower] with
98+
99+
````bash
100+
$ bower install --save sass-package
101+
````
102+
103+
Alternatively, you can download a [release][Releases]
104+
or clone the repository directly.
105+
106+
## Development and Testing
107+
96108
### Source Code
97109

98110
The [sass-package](https://github.com/razor-x/sass-package)
@@ -103,6 +115,18 @@ To clone the project run
103115
$ git clone https://github.com/razor-x/sass-package.git
104116
````
105117

118+
### Requirements
119+
120+
You will need [Ruby] ≥ 2 with [Bundler] and [Bower].
121+
122+
Install the development dependencies with
123+
124+
````bash
125+
$ bundle
126+
````
127+
128+
[Ruby]: https://www.ruby-lang.org/
129+
106130
### Rake
107131

108132
Run `rake -T` to see all Rake tasks.
@@ -114,7 +138,7 @@ rake clean # Remove build directory
114138

115139
### Guard
116140

117-
Guard will watch the sass files under `src` and complile on changes.
141+
Guard will watch the sass files under `src` and compile on changes.
118142
Just run `guard`.
119143

120144
## Contributing

0 commit comments

Comments
 (0)