Update documentation files according to the newer templates

neilvcarvalho · neilvcarvalho · commit 3c512549c5e3 · 2025-06-06T16:50:55.000-03:00
Also configure GitHub workflows to keep the README and SECURITY files
up-to-date.
diff --git a/.github/workflows/dynamic-readme.yml b/.github/workflows/dynamic-readme.yml
@@ -0,0 +1,19 @@
+name: update-templates
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - README.md
+  workflow_dispatch:
+
+jobs:
+  update-templates:
+    permissions:
+      contents: write
+      pull-requests: write
+      pages: write
+    uses: thoughtbot/templates/.github/workflows/dynamic-readme.yaml@main
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/dynamic-security.yml b/.github/workflows/dynamic-security.yml
@@ -0,0 +1,19 @@
+name: update-security
+
+on:
+  push:
+    paths:
+      - SECURITY.md
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  update-security:
+    permissions:
+      contents: write
+      pull-requests: write
+      pages: write
+    uses: thoughtbot/templates/.github/workflows/dynamic-security.yaml@main
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,9 +2,11 @@
 
 We love pull requests. Here's a quick guide.
 
-Fork the repo:
+Fork the repo.
 
-    git clone git@github.com:thoughtbot/flutie.git
+Clone your fork:
+
+    git clone git@github.com:your-username/flutie.git
 
 Set up your machine:
 
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2010-2013 thoughtbot, inc
+Copyright (c) thoughtbot, inc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Flutie
 
-[![Build Status](https://travis-ci.org/thoughtbot/flutie.svg?branch=master)](https://travis-ci.org/thoughtbot/flutie)
+# Flutie [![Build Status][ci-image]][ci] [![Gem Version][version-image]][version]
 
 Flutie provides some utility view helpers for use with Rails applications.
 
@@ -9,7 +9,7 @@ There are helpers for setting a page title and for generating body classes.
 ## Installation & Upgrading
 
 Flutie is a Railtie. We support the versions of Ruby and Rails listed in
-[.travis.yml](.travis.yml).
+[.github/workflows/build.yml](.github/workflows/build.yml).
 
 It should be run as a gem and included in your `Gemfile`:
 
@@ -46,7 +46,7 @@ These can be overridden by passing an options hash including `:app_name`,
 
 ```ruby
 content_for(:site_page_title, 'My title of my page')
-page_title(:app_name => 'My app name', :page_title_symbol => :site_page_title, :separator => " | ")
+page_title(app_name: 'My app name', page_title_symbol: :site_page_title, separator: " | ")
 ```
 
 would produce:
@@ -60,7 +60,7 @@ values by using the `:reverse` option. For example:
 
 ```ruby
 content_for(:site_page_title, 'My title of my page')
-page_title(:app_name => 'My app name', :page_title_symbol => :site_page_title, reverse: true)
+page_title(app_name: 'My app name', page_title_symbol: :site_page_title, reverse: true)
 ```
 
 would produce:
@@ -98,9 +98,13 @@ would produce:
 <body class="widgets widgets-show special-page">
 ```
 
-## How to contribute
+## Contributing
 
-Please see the [CONTRIBUTING](CONTRIBUTING.md) file for details.
+See the [CONTRIBUTING] document.
+Thank you, [contributors]!
+
+[CONTRIBUTING]: CONTRIBUTING.md
+[contributors]: https://github.com/thoughtbot/flutie/graphs/contributors
 
 ## Credits
 
@@ -121,3 +125,25 @@ Flutie is Copyright © 2010 thoughtbot, inc. It is free software, and may be
 redistributed under the terms specified in the [LICENSE](LICENSE) file.
 
 [the contributors]: https://github.com/thoughtbot/flutie/contributors
+
+<!-- START /templates/footer.md -->
+## About thoughtbot
+
+![thoughtbot](https://thoughtbot.com/thoughtbot-logo-for-readmes.svg)
+
+This repo is maintained and funded by thoughtbot, inc.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+We love open source software!
+See [our other projects][community].
+We are [available for hire][hire].
+
+[community]: https://thoughtbot.com/community?utm_source=github
+[hire]: https://thoughtbot.com/hire-us?utm_source=github
+
+<!-- END /templates/footer.md -->
+
+[ci-image]: https://github.com/thoughtbot/flutie/actions/workflows/build.yml/badge.svg?branch=main
+[ci]: https://github.com/thoughtbot/flutie/actions?query=workflow%3ABuild+branch%3Amain
+[version-image]: https://badge.fury.io/rb/flutie.svg
+[version]: https://badge.fury.io/rb/flutie
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,19 @@
+<!-- START /templates/security.md -->
+# Security Policy
+
+## Supported Versions
+
+Only the the latest version of this project is supported at a given time. If
+you find a security issue with an older version, please try updating to the
+latest version first.
+
+If for some reason you can't update to the latest version, please let us know
+your reasons so that we can have a better understanding of your situation.
+
+## Reporting a Vulnerability
+
+For security inquiries or vulnerability reports, visit
+<https://thoughtbot.com/security>.
+
+If you have any suggestions to improve this policy, visit <https://thoughtbot.com/security>.
+<!-- END /templates/security.md -->
