README.md in gitlab-gollum-lib-4.2.7.9 vs README.md in gitlab-gollum-lib-4.2.7.10.gitlab.1

- old
+ new

@@ -1,13 +1,17 @@ -gollum lib -- A wiki built on top of Git [![build status](https://ci.gitlab.org/projects/7/status.png?ref=master)](https://ci.gitlab.org/projects/7?ref=master) +gollum lib -- A wiki built on top of Git. + ======================================== [![pipeline status](https://gitlab.com/gitlab-org/gollum-lib/badges/master/pipeline.svg)](https://gitlab.com/gitlab-org/gollum-lib/-/commits/master) -[![Gem Version](https://badge.fury.io/rb/gollum-lib.svg)](http://badge.fury.io/rb/gollum-lib) -[![Build Status](https://travis-ci.org/gollum/gollum-lib.svg?branch=master)](https://travis-ci.org/gollum/gollum-lib) -[![Dependency Status](https://gemnasium.com/gollum/gollum-lib.svg)](https://gemnasium.com/gollum/gollum-lib) +[![Gem Version](https://badge.fury.io/rb/gitlab-gollum-lib.svg)](http://badge.fury.io/rb/gitlab-gollum-lib) +## This is a fork + +It is made for the GitLab application and used in the [Gitaly](https://gitlab.com/gitlab-org/gitaly) project. +For use outside of GitLab, refer to the upstream [`gollum-lib`](https://github.com/gollum/gollum-lib) gem. + ## DESCRIPTION [Gollum](https://github.com/gollum/gollum) is a simple wiki system built on top of Git that powers GitHub Wikis. @@ -18,20 +22,20 @@ Gollum-lib follows the rules of [Semantic Versioning](http://semver.org/) and uses [TomDoc](http://tomdoc.org/) for inline documentation. ## SYSTEM REQUIREMENTS -- Ruby 1.9.3+ (>2.0 recommended) +- Ruby 2.4+ - Unix like operating system (OS X, Ubuntu, Debian, and more) -- By default the [Rugged adapter](https://gitlab.com/gitlab-org/gitlab-gollum-rugged_adapter) is used for MRI, and [RJGit](https://github.com/gollum/rjgit_adapter) for JRuby. -- Will not work on Windows with the [grit](https://github.com/github/grit) adapter, but might work via JRuby (please let us know!) +- By default the [Rugged adapter](https://gitlab.com/gitlab-org/gitlab-gollum-rugged_adapter) is used for MRI. +- Will not work on Windows. ## INSTALLATION The best way to install Gollum-lib is with RubyGems: ```bash -$ [sudo] gem install gollum-lib +$ [sudo] gem install gitlab-gollum-lib ``` If you're installing from source, you can use [Bundler][bundler] to pick up all the gems: