README.md in heel-3.2.1 vs README.md in heel-4.0.0
- old
+ new
@@ -1,29 +1,30 @@
## Heel
+[](https://copiousfreetime.semaphoreci.com/projects/heel)
-* [Homepage](http://github.com/copiousfreetime/heel/)
-* [GitHub](http://github.com/copiousfreetime/heel/)
-* email jeremy at hinegardner dot org
-* `git clone git://github.com/copiousfreetime/heel.git`
+* [Homepage](https://github.com/copiousfreetime/heel/)
+* [GitHub](https://github.com/copiousfreetime/heel/)
## DESCRIPTION
Heel is a small static web server for use when you need a quick web server for a
directory. Once the server is running, heel will use
-[launchy](http://rubygems.org/gems/launchy/) to open your browser at
+[launchy](https://rubygems.org/gems/launchy/) to open your browser at
the URL of your document root.
-Heel is built using [Rack](http://rack.github.com) and
-[Puma](http://puma.io)
+Heel is built using [Rack](https://github.com/rack/rack) and
+[Puma](https://puma.io)
% heel
Launching your browser...
Puma starting in single mode...
- * Version 3.11.3 (ruby 2.4.3-p205), codename: Love Song
- * Min threads: 0, max threads: 16
- * Environment: none
- * Listening on tcp://0.0.0.0:4331
+ * Puma version: 6.2.1 (ruby 3.2.2-p53) ("Speaking of Now")
+ * Min threads: 0
+ * Max threads: 5
+ * Environment: none
+ * PID: 11322
+ * Listening on http://0.0.0.0:4331
Use Ctrl-C to stop
Or run it in the background
% heel --daemonize
@@ -33,12 +34,12 @@
Sending TERM to process 3304
Done.
## FEATURES
-* Automatic launching of your browser to the URL it is serving with [launchy](http://github.com/copiousfreetime/launchy/)
-* Automatic syntax highlighting of source code files with [coderay](http://coderay.rubychan.de/)
+* Automatic launching of your browser to the URL it is serving with [launchy](https://github.com/copiousfreetime/launchy/)
+* Automatic syntax highlighting of source code files with [rouge](https://github.com/ruby-rouge/rouge))
* Run in the foreground or daemonized
* Bind to any address and port (default is 0.0.0.0:4331)
## SYNOPSIS:
@@ -48,11 +49,11 @@
(default: 0.0.0.0)
-d, --daemonize Run daemonized in the background
-h, --help Display this text
-k, --kill Kill an existing daemonized heel process
--[no-]highlighting Turn on or off syntax highlighting
- (default: off)
+ (default: on)
--[no-]launch-browser Turn on or off automatic browser launch
(default: on)
-p, --port PORT Port to bind to
(default: 4331)
-r, --root ROOT Set the document root
@@ -61,33 +62,35 @@
## REQUIREMENTS:
### For running:
-* [coderay](http://coderay.rubychan.de/)
-* [launchy](http://github.com/copiousfreetime/launchy/) >= 0.1.1
-* [mime-types](http://mime-types.rubyforge.org/)
-* [puma](http://puma.io)
+* [rouge](https://github.com/rouge-ruby/rouge)
+* [launchy](https://github.com/copiousfreetime/launchy/)
+* [mime-types](https://github.com/mime-types/ruby-mime-types/)
+* [puma](https://puma.io)
+* [rackup](https://github.com/rack/rackup)
### For development:
-* [minitest](http://rubygems.org/gems/minitest)
-* [rake](http://rubygems.org/gems/rake)
-* [rdoc](http://rubygems.org/gems/rdoc)
+* [minitest](https://rubygems.org/gems/minitest)
+* [rake](https://rubygems.org/gems/rake)
+* [rdoc](https://rubygems.org/gems/rdoc)
## INSTALL:
* `gem install heel`
## CREDITS:
-* [puma](http://puma.io)
-* [Rack](http://rack.github.io/)
-* http://www.famfamfam.com/ for amazing icons
+* [puma](https://puma.io)
+* [Rack](https://github.com/rack/rack)
+* [lineicons](https://lineicons.com/)
+* [picocss](https://picocss.com/)
## BSD LICENSE:
-Copyright (c) 2007 - 2013, Jeremy Hinegardner
+Copyright (c) 2007 - 2023, Jeremy Hinegardner
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: