v1.0.0

mikker · Oct 12, 2023 · f9540f3 · f9540f3
1 parent e1ccafd
commit f9540f3
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 31 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,12 +1,12 @@
 # Changelog
 
-## Unreleased
+## 1.0.0 (🎉)
 
 ### Breaking changes
 
 **This major release of Passwordless changes a lot of things and it is almost guaranteed that you will need to change your code to upgrade to this version.**
 
-Note that there is no _need_ to upgrade. The previous versions of Passwordless will continue to work for the foreseeable future.
+(Note that there is no _need_ to upgrade. The previous versions of Passwordless will continue to work for the foreseeable future.)
 
 See [Upgrading to Passwordless 1.0](docs/upgrading_to_1_0.md) for more details.
 

diff --git a/README.md b/README.md
@@ -1,7 +1,3 @@
-**NOTE:** Passwordless is currently going through some breaking changes. Be aware that the docs in `master` aren't necessarily the same as for you installed version.
-
----
-
 <p align='center'>
   <img src='https://s3.brnbw.com/Passwordless-title-gaIVkX0sPg.svg' alt='Passwordless' />
   <br />
@@ -14,30 +10,6 @@ Add authentication to your Rails app without all the icky-ness of passwords.
 
 ---
 
-## Table of Contents
-
-<!--toc:start-->
-
-- [Table of Contents](#table-of-contents)
-- [Installation](#installation)
-- [Usage](#usage)
-  - [Getting the current user, restricting access, the usual](#getting-the-current-user-restricting-access-the-usual)
-  - [Providing your own templates](#providing-your-own-templates)
-  - [Registering new users](#registering-new-users)
-  - [URLs and links](#urls-and-links)
-- [Configuration](#configuration)
-  - [Delivery method](#delivery-method)
-  - [Token generation](#token-generation)
-  - [Timeout and Expiry](#timeout-and-expiry)
-  - [Redirection after sign-in](#redirection-after-sign-in)
-  - [Looking up the user](#looking-up-the-user)
-  - [Claiming tokens](#claiming-tokens)
-- [Test helpers](#test-helpers)
-- [Security considerations](#security-considerations)
-- [Alternatives](#alternatives)
-- [License](#license)
-<!--toc:end-->
-
 ## Installation
 
 Add to your bundle and copy over the migrations:
@@ -47,6 +19,10 @@ $ bundle add passwordless
 $ bin/rails passwordless:install:migrations
 ```
 
+### Upgrading
+
+See [Upgrading to Passwordless 1.0](docs/upgrading_to_1_0.md) for more details.
+
 ## Usage
 
 Passwordless creates a single model called `Passwordless::Session`. It doesn't come with its own `User` model, it expects you to create one:

diff --git a/lib/passwordless/version.rb b/lib/passwordless/version.rb
@@ -2,5 +2,5 @@
 
 module Passwordless
   # :nodoc:
-  VERSION = "1.0.0.beta1"
+  VERSION = "1.0.0"
 end