Skip to content

Commit ffdd27c

Browse files
modify gem desc and readme
badging exercise
1 parent adb81ec commit ffdd27c

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

README.md

+17-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
1-
# jekyll-theme-dusk
2-
This theme was built for GitHub Pages.
1+
# Dusk
2+
3+
### Jekyll Theme
4+
5+
[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/Parmjot-Singh/jekyll-theme-dusk/master/LICENSE.txt)
6+
[![Ruby gem](https://img.shields.io/gem/v/jekyll-theme-dusk?color=yellow
7+
)](https://rubygems.org/gems/jekyll-theme-dusk)
8+
[![GitHub Releases](https://img.shields.io/github/v/release/Parmjot-Singh/jekyll-theme-dusk?color=yellow)](https://github.com/Parmjot-Singh/jekyll-theme-dusk/releases/latest)
9+
10+
A dark Jekyll theme compatible with GitHub Pages, with emphasis on elegance.
311

412
### WARNING
513
This theme assumes that your images are stored at
@@ -11,22 +19,22 @@ It's good practice to put your assets in an assets folder, in my opinion at leas
1119
## Installation
1220

1321
Add this line to your Jekyll site's `Gemfile`:
14-
```
15-
ruby
16-
gem "jekyll-theme-dusk"
22+
```ruby
23+
24+
gem "jekyll-theme-dusk", "~> 0.5.2"
1725
```
1826
And add this line to your Jekyll site's `_config.yml`:
19-
```
20-
yaml
27+
```yaml
28+
2129
theme: jekyll-theme-dusk
2230
```
2331
And then execute:
2432
```
25-
$ bundle
33+
$ bundle
2634
```
2735
Or install it yourself as:
2836
```
29-
$ gem install jekyll-theme-dusk
37+
$ gem install jekyll-theme-dusk
3038
```
3139
## Usage
3240

jekyll-theme-dusk.gemspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Gem::Specification.new do |spec|
55
spec.version = "0.5.2" # Keep this at line 5 for GitHub release action
66
spec.authors = ["Parmjot Singh"]
77
spec.email = ["[email protected]"]
8-
spec.summary = "A dark coloured Jekyll theme compatible with GitHub Pages, with emphasis on elegance?"
8+
spec.summary = "A dark Jekyll theme compatible with GitHub Pages, with emphasis on elegance. This theme is still in development, so expect issues."
99
spec.homepage = "https://github.com/Parmjot-Singh/jekyll-theme-dusk/"
1010
spec.license = "MIT"
1111
spec.metadata = {

0 commit comments

Comments
 (0)