From 190851c6b22af78c18908e18cc3023e52a57fb5d Mon Sep 17 00:00:00 2001 From: Peter Yates Date: Thu, 7 Nov 2019 08:55:10 +0000 Subject: [PATCH 1/2] Add dependabot status button --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd9ddf4a..340b20c4 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Maintainability](https://api.codeclimate.com/v1/badges/fde73b5dc9476197281b/maintainability)](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/fde73b5dc9476197281b/test_coverage)](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/test_coverage) [![Gem Version](https://badge.fury.io/rb/govuk_design_system_formbuilder.svg)](https://badge.fury.io/rb/govuk_design_system_formbuilder) -[![Netlify Status](https://api.netlify.com/api/v1/badges/d4c50b8d-6ca3-4797-9ab3-6e0731c72b44/deploy-status)](https://app.netlify.com/sites/govuk-form-builder/deploys) +[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=DFE-Digital/govuk_design_system_formbuilder)](https://dependabot.com) This gem provides a easy-to-use form builder that generates forms that are fully-compliant with version 3.3.0 of the [GOV.UK Design System](https://design-system.service.gov.uk/), @@ -25,6 +25,8 @@ If you're still not sure what a form builder is or how it works, don't worry! an idea of what's on offer and [the official guide](https://govuk-form-builder.netlify.com) goes into a bit more depth on how everything works 😅 +[![Netlify Status](https://api.netlify.com/api/v1/badges/d4c50b8d-6ca3-4797-9ab3-6e0731c72b44/deploy-status)](https://app.netlify.com/sites/govuk-form-builder/deploys) + ## What's included * 100% compatibility with the GOV.UK Design System From 5b7361b659d860be4b075a1d890360ca5d146926 Mon Sep 17 00:00:00 2001 From: Peter Yates Date: Thu, 7 Nov 2019 08:57:29 +0000 Subject: [PATCH 2/2] Adjust the readme content, make a bit friendlier! --- README.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 340b20c4..c67a47a0 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ [![Build Status](https://travis-ci.com/DFE-Digital/govuk_design_system_formbuilder.svg?branch=master)](https://travis-ci.com/DFE-Digital/govuk_design_system_formbuilder) [![Maintainability](https://api.codeclimate.com/v1/badges/fde73b5dc9476197281b/maintainability)](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/maintainability) -[![Test Coverage](https://api.codeclimate.com/v1/badges/fde73b5dc9476197281b/test_coverage)](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/test_coverage) [![Gem Version](https://badge.fury.io/rb/govuk_design_system_formbuilder.svg)](https://badge.fury.io/rb/govuk_design_system_formbuilder) +[![Test Coverage](https://api.codeclimate.com/v1/badges/fde73b5dc9476197281b/test_coverage)](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/test_coverage) [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=DFE-Digital/govuk_design_system_formbuilder)](https://dependabot.com) This gem provides a easy-to-use form builder that generates forms that are @@ -20,14 +20,20 @@ to text areas or [setting the size and weight of labels](https://govuk-form-builder.netlify.com/introduction/labels-hints-and-legends/) on text fields requires only a single argument. +## Documentation 📚 + +The gem comes with [a full guide](https://govuk-form-builder.netlify.com/) that +covers most aspects of day-to-day use, along with code and output examples. The guide +is generated from the builder itself so it will always be up to date. + If you're still not sure what a form builder is or how it works, don't worry! [This screencast](https://www.youtube.com/watch?v=PhoFZ0qXAlA) should give you -an idea of what's on offer and [the official guide](https://govuk-form-builder.netlify.com) goes -into a bit more depth on how everything works 😅 +an idea of what's on offer and the official guide goes into a bit more depth on +how everything works. [![Netlify Status](https://api.netlify.com/api/v1/badges/d4c50b8d-6ca3-4797-9ab3-6e0731c72b44/deploy-status)](https://app.netlify.com/sites/govuk-form-builder/deploys) -## What's included +## What's included 🧳 * 100% compatibility with the GOV.UK Design System * Full control of labels, hints, fieldsets and legends @@ -38,10 +44,9 @@ into a bit more depth on how everything works 😅 button collections * No external dependencies * An exhaustive test suite -* [Extensive documentation](https://www.rubydoc.info/gems/govuk_design_system_formbuilder/GOVUKDesignSystemFormBuilder/Builder) -* [A full guide](https://govuk-form-builder.netlify.com/) +* [Extensive technical documentation](https://www.rubydoc.info/gems/govuk_design_system_formbuilder/GOVUKDesignSystemFormBuilder/Builder) -## Installation +## Installation 🏗 You can install the form builder gem by running the `gem install govuk_design_system_formbuilder` or by adding the following line @@ -61,7 +66,7 @@ pre-configured template: * [DfE Boilerplate](https://github.com/DFE-Digital/govuk-rails-boilerplate) * [MoJ Rails Template](https://github.com/ministryofjustice/moj_rails_template) -## Setup +## Setup 🔧 To use the form builder in an ad hoc basis you can specify it as an argument to `form_for` or `form_with`: @@ -79,7 +84,7 @@ class ApplicationController < ActionController::Base end ``` -Now we can get started! 🎉 +Now we can get started! ```slim = form_for @person do |f| @@ -99,7 +104,7 @@ Now we can get started! 🎉 = f.govuk_submit 'Away we go!' ``` -## Developing and running the tests +## Developing and running the tests 🧑🏼‍🔬 The form builder is covered by RSpec, to run all the tests first ensure that all of the development and testing prerequisite gems are installed. At the root @@ -115,7 +120,7 @@ Now, if everything was successful, run RSpec: bundle exec rspec -fd ``` -## Contributing +## Contributing 🎁 Bug reports and feature requests are most welcome, please raise an issue or submit a pull request. @@ -124,7 +129,7 @@ Currently we're using [GOVUK Lint](https://github.com/alphagov/govuk-lint) to ensure code meets the GOV.UK guidelines. Please ensure that any PRs also adhere to this standard. -## Thanks +## Thanks 👩🏽‍⚖️ -This project was inspired by [MoJ's GovukElementsFormBuilder](https://github.com/ministryofjustice/govuk_elements_form_builder), +This project was inspired by [Ministry of Justice's GovukElementsFormBuilder](https://github.com/ministryofjustice/govuk_elements_form_builder), but is leaner, more modular and written in a more idiomatic style.