Add upgrade guide and update Readme for v1 (#331)

* Add upgrade guide

* Wip

* Wip

* Update GitHub actions to not run on Markdown files

* Wip

* Formatting

* Add changes in #337

* Add anchor links

* Add changes in #338

* Add changes in #341, formatting

* Wip

* Update usage examples in Readme

* Move CSP section down

* LICENSE.md → LICENSE

* Wip

* Wip

* Formatting

* Add new features section to Upgrading

* Prep Changelog headers and tags for v1

* Move current() with query fix to Fixed section

* Add entries for #334 and #344 to Upgrading

* Add Upgrading entry for check() being deprecated

* Add #345 to Upgrading

* Wip on Readme

* JavaScript → Javascript

* Wording/formatting

* Update Readme:
- Move Usage above Setup
- Remove 'basic setup' section about @routes directive, it's covered in Installation
- Wording fixes
- Add note about boolean encoding (see #345)
- Remove old 'Artisan Command' section

* Formatting

* Formatting and wording

* Javascript → JavaScript

* Remove unused heading link

* Add section under 'Other' for setting up an API endpoint to return routes, link to that from SPA and JS sections

* Fix wording re: watching files

* :)

.editorconfig

@@ -9,6 +9,7 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 
 [*.md]
+indent_size = 2
 trim_trailing_whitespace = false
 
 [*.yml]

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,20 +2,18 @@
 name: Bug report
 about: Report an issue to help us improve Ziggy
 title: ''
-labels: needs triage
 assignees: ''
-
 ---
 
-### Description
+#### Description
 
 <!-- Provide a clear and concise description of the current behaviour and what the bug is. -->
 
-### Expected behavior
+#### Expected behavior
 
 <!-- Provide a clear and concise description of what you expected to happen. -->
 
-### Environment
+#### Environment
 
 <!-- Include ALL of the information below: -->
 
@@ -44,7 +42,7 @@ Route::get('/', 'HomeController')->name('home');
 }
 ```
 
-**Ziggy call**:
+**Ziggy call and context**:
 
 <!-- Show where and how you're using Ziggy when this bug occurs. E.g.: -->
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -2,19 +2,17 @@
 name: Feature request
 about: Suggest a new feature for Ziggy
 title: ''
-labels: enhancement, needs triage
 assignees: ''
-
 ---
 
-### Description
+#### Description
 
 <!-- Is your request related to a problem? If so, please describe the problem. E.g.: I'm always frustrated when [...] -->
 
-### Suggestion
+#### Suggestion
 
 <!-- Tell us about the solution you'd like, with a clear and concise description of what you want to happen. -->
 
-### Alternatives
+#### Alternatives
 
 <!-- Describe alternative solutions and approaches you considered, if any. -->

.github/workflows/tests.yml

@@ -2,16 +2,10 @@ name: Tests
 
 on:
   pull_request:
-    paths-ignore:
-      - 'dist/**'
-      - '*.md'
+    paths-ignore: ['dist/**', '*.md']
   push:
-    branches:
-      - develop
-      - master
-    paths-ignore:
-      - 'dist/**'
-      - '*.md'
+    branches: [main, develop, 0.9.x]
+    paths-ignore: ['dist/**', '*.md']
 
 jobs:
   test:

CHANGELOG.md

@@ -4,10 +4,10 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), and the format of this changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [Unreleased]
-
 Breaking changes are marked with ⚠️.
 
+## [v1.0.0] - 
+
 **Added**
 
 - Document the `check()` method ([#294](https://github.com/tighten/ziggy/pull/294)) and how to install and use Ziggy via `npm` and over a CDN ([#299](https://github.com/tighten/ziggy/pull/299))
@@ -27,7 +27,6 @@ Breaking changes are marked with ⚠️.
 - Use Jest instead of Mocha for JS tests ([#309](https://github.com/tighten/ziggy/pull/309))
 - Use [microbundle](https://github.com/developit/microbundle) instead of Webpack to build and distribute Ziggy ([#312](https://github.com/tighten/ziggy/pull/312))
 - ⚠️ Default Ziggy's `baseUrl` to the value of the `APP_URL` environment variable instead of `url('/')` ([#334](https://github.com/tighten/ziggy/pull/334))
-- ⚠️ Allow getting the route name with `current()` when the current URL has a query string ([#330](https://github.com/tighten/ziggy/pull/330))
 - ⚠️ Return a literal string from the `route()` function when any arguments are passed to it ([#336](https://github.com/tighten/ziggy/pull/336))
 - ⚠️ Rename `namedRoutes` → `routes`, `defaultParameters` → `defaults`, `baseUrl` → `url`, and `basePort` → `port` ([#338](https://github.com/tighten/ziggy/pull/338))
 - ⚠️ Make the `filter()` method on the `Ziggy` class return an instance of that class instead of a collection of routes ([#341](https://github.com/tighten/ziggy/pull/341))
@@ -57,14 +56,15 @@ Breaking changes are marked with ⚠️.
 - Fix port not being added to URL for routes with subdomains ([#293](https://github.com/tighten/ziggy/pull/293))
 - Fix getting parameters of routes in apps installed in subfolders ([#302](https://github.com/tighten/ziggy/pull/302))
 - Ensure fallback routes are always last, thanks [@davejamesmiller](https://github.com/davejamesmiller)! ([#310](https://github.com/tighten/ziggy/pull/310))
+- Allow getting the route name with `current()` when the current URL has a query string ([#330](https://github.com/tighten/ziggy/pull/330))
 
-## [0.9.4] - 2020-06-05
+## [v0.9.4] - 2020-06-05
 
 **Fixed**
 
 - Fix escaping of `.` characters in the `current()` method, thanks [@davejamesmiller](https://github.com/davejamesmiller)! ([#296](https://github.com/tighten/ziggy/pull/296))
 
-## [0.9.3] - 2020-05-08
+## [v0.9.3] - 2020-05-08
 
 **Added**
 
@@ -85,6 +85,7 @@ Breaking changes are marked with ⚠️.
 
 For previous changes see the [Releases](https://github.com/tighten/ziggy/releases) page.
 
-[Unreleased]: https://github.com/tighten/ziggy/compare/0.9.4...HEAD
-[0.9.4]: https://github.com/tighten/ziggy/compare/0.9.3...0.9.4
-[0.9.3]: https://github.com/tighten/ziggy/compare/v0.9.2...0.9.3
+[Unreleased]: https://github.com/tighten/ziggy/compare/v1.0.0...HEAD
+[v1.0.0]: https://github.com/tighten/ziggy/compare/0.9.4...v1.0.0
+[v0.9.4]: https://github.com/tighten/ziggy/compare/0.9.3...0.9.4
+[v0.9.3]: https://github.com/tighten/ziggy/compare/v0.9.2...0.9.3