Skip to content

Commit

Permalink
modify gem desc and readme
Browse files Browse the repository at this point in the history
badging exercise
  • Loading branch information
parmjotsinghrobot committed Jan 22, 2024
1 parent adb81ec commit ffdd27c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 10 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# jekyll-theme-dusk
This theme was built for GitHub Pages.
# Dusk

### Jekyll Theme

[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/Parmjot-Singh/jekyll-theme-dusk/master/LICENSE.txt)
[![Ruby gem](https://img.shields.io/gem/v/jekyll-theme-dusk?color=yellow
)](https://rubygems.org/gems/jekyll-theme-dusk)
[![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)

A dark Jekyll theme compatible with GitHub Pages, with emphasis on elegance.

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

Add this line to your Jekyll site's `Gemfile`:
```
ruby
gem "jekyll-theme-dusk"
```ruby

gem "jekyll-theme-dusk", "~> 0.5.2"
```
And add this line to your Jekyll site's `_config.yml`:
```
yaml
```yaml

theme: jekyll-theme-dusk
```
And then execute:
```
$ bundle
$ bundle
```
Or install it yourself as:
```
$ gem install jekyll-theme-dusk
$ gem install jekyll-theme-dusk
```
## Usage

Expand Down
2 changes: 1 addition & 1 deletion jekyll-theme-dusk.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Gem::Specification.new do |spec|
spec.version = "0.5.2" # Keep this at line 5 for GitHub release action
spec.authors = ["Parmjot Singh"]
spec.email = ["[email protected]"]
spec.summary = "A dark coloured Jekyll theme compatible with GitHub Pages, with emphasis on elegance?"
spec.summary = "A dark Jekyll theme compatible with GitHub Pages, with emphasis on elegance. This theme is still in development, so expect issues."
spec.homepage = "https://github.com/Parmjot-Singh/jekyll-theme-dusk/"
spec.license = "MIT"
spec.metadata = {
Expand Down

0 comments on commit ffdd27c

Please sign in to comment.