Rename option auto-id' to unique-id'

README.org

@@ -14,6 +14,8 @@ user modifies them manually.
 - [[#introduction][Introduction]]
 - [[#installation][Installation]]
 - [[#usage][Usage]]
+- [[#breaking-changes][Breaking changes]]
+  - [[#040][~0.4.0~]]
 - [[#contributing][Contributing]]
 - [[#license][License]]
 
@@ -49,12 +51,12 @@ While ~org-unique-id~ may be installed on your Emacs instance, it is not
 active by default. This is because it can take some time to generate
 all the required IDs in your org file which may hang your Emacs
 instance for a bit. Therefore, automatic IDs are enabled on a per-file
-basis with the option ~auto-id~.
+basis with the option ~unique-id~.
 
 Here is an example of an org buffer with ~org-unique-id~ enabled:
 #+begin_src org
 ,#+title: Test file
-,#+options: auto-id:t
+,#+options: unique-id:t
 
 ,* Test level 1
 :PROPERTIES:
@@ -77,7 +79,7 @@ the ~CUSTOM_ID~ and let ~org-unique-id~ regenerate it. If you don’t like
 the ~CUSTOM_ID~ generated by ~org-unique-id~, you can overwrite it
 yourself and ~org-unique-id~ will not modify it.
 
-Note that ~auto-id:t~ is absolutely required in order to get these
+Note that ~unique-id:t~ is absolutely required in order to get these
 ~CUSTOM_ID~. Here is the same buffer after save without this option:
 #+begin_src org
 ,#+title: Test file
@@ -88,7 +90,11 @@ Note that ~auto-id:t~ is absolutely required in order to get these
 
 It is also possible to manually call ~org-unique-id~ (interactively or
 not) on the current buffer. This will not check the value of the
-~auto-id~ option.
+~unique-id~ option.
+
+* Breaking changes
+** ~0.4.0~
+The option ~auto-id~ is renamed to ~unique-id~.
 
 * Contributing
 See [[file:CONTRIBUTING.org]].