Rename from antsibull_docs to antsibull-docs. (#15)

ansible-community · Mar 13, 2023 · c4c1d6a · c4c1d6a
1 parent cba8f00
commit c4c1d6a
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -14,10 +14,12 @@ This is a TypeScript library for processing Ansible documentation markup. It is
 
 ## How to use this
 
+The package is available on [npm](https://www.npmjs.com/package/antsibull-docs).
+
 ### Node.js (CommonJS modules)
 
 ```js
-const { parse, toHTML } = require('antsibull_docs');
+const { parse, toHTML } = require('antsibull-docs');
 
 function convert() {
   return toHTML(parse(['First paragraph.', 'Second B(paragraph).']));
@@ -27,7 +29,7 @@ function convert() {
 ### Webpack (EcmaScript modules)
 
 ```ts
-import { parse, toHTML } from 'antsibull_docs';
+import { parse, toHTML } from 'antsibull-docs';
 
 function convert(): string {
   return toHTML(parse(['First paragraph.', 'Second B(paragraph).']));

diff --git a/changelogs/fragments/rename.yml b/changelogs/fragments/rename.yml
@@ -0,0 +1,2 @@
+breaking_changes:
+  - "The package was renamed on npmjs.com from ``antsibull_docs`` to ``antsibull-docs`` (https://github.com/ansible-community/antsibull-docs-ts/pull/15)."
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "antsibull_docs",
+  "name": "antsibull-docs",
   "version": "0.1.0",
   "description": "TypeScript library for processing Ansible documentation markup",
   "main": "dist/cjs/index.js",
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		breaking_changes:
		- "The package was renamed on npmjs.com from ``antsibull_docs`` to ``antsibull-docs`` (https://github.com/ansible-community/antsibull-docs-ts/pull/15)."