Skip to content

Commit

Permalink
Improved documentation links.
Browse files Browse the repository at this point in the history
  • Loading branch information
ioquatix committed Jan 31, 2024
1 parent 6b568c0 commit c75894f
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 2 deletions.
File renamed without changes.
4 changes: 4 additions & 0 deletions falcon.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ Gem::Specification.new do |spec|

spec.homepage = "https://github.com/socketry/falcon"

spec.metadata = {
"documentation_uri" => "https://socketry.github.io/falcon/",
}

spec.files = Dir.glob(['{bake,bin,lib}/**/*', '*.md'], File::FNM_DOTMATCH, base: __dir__)

spec.executables = ["falcon", "falcon-host"]
Expand Down
1 change: 0 additions & 1 deletion gems.rb
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
gem "bake-modernize"
gem "bake-gem"

gem "bake-github-pages"
gem "utopia-project"
end

Expand Down
14 changes: 13 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,19 @@ Please visit [Socketry.io](https://socketry.io) to register and subscribe.

## Usage

Please see the <a href="https://socketry.github.io/falcon/">project documentation</a> or run it locally using `bake utopia:project:serve`.
Please see the [project documentation](https://socketry.github.io/falcon/) for more details.

- [Getting Started](https://socketry.github.io/falcon/guides/getting-started/index) - This guide explains how to use Falcon for Ruby web application development.

- [Rails Integration](https://socketry.github.io/falcon/guides/rails-integration/index) - This guide explains how to host Rails applications with Falcon.

- [Deployment](https://socketry.github.io/falcon/guides/deployment/index) - This guide explains how to use Falcon in production environments.

- [Extended Features](https://socketry.github.io/falcon/guides/extended-features/index) - This guide explains some of the extended features and functionality of Falcon.

- [Performance Tuning](https://socketry.github.io/falcon/guides/performance-tuning/index) - This guide explains the performance characteristics of Falcon.

- [How It Works](https://socketry.github.io/falcon/guides/how-it-works/index) - This guide gives an overview of how Falcon handles an incoming web request.

## Contributing

Expand Down

0 comments on commit c75894f

Please sign in to comment.