Skip to content

Commit e474de2

Browse files
publish instructions
1 parent 31fa56c commit e474de2

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Repository for typedef files for various Adobe Creative Cloud products.
1414

1515
## Prerequisites
1616

17-
* [Node.js](https://nodejs.org/en/download/)
18-
* [TypeScript](https://typescriptlang.org/#download-links)
19-
* [git](https://git-scm.com/)
17+
- [Node.js](https://nodejs.org/en/download/)
18+
- [TypeScript](https://typescriptlang.org/#download-links)
19+
- [git](https://git-scm.com/)
2020

2121
---
2222

@@ -52,7 +52,7 @@ tsc
5252
Everything in this project was generated through one of the following methods:
5353

5454
1. Using this [extendscript-xml-to-typescript converter](https://github.com/aenhancers/extendscript-xml-to-typescript) tool to convert scripting dictionaries to typedef format
55-
- *note that this only works for a few select apps, and has been found to generate incorrect data in some cases*
55+
- _note that this only works for a few select apps, and has been found to generate incorrect data in some cases_
5656
2. By hand, through referencing Adobe's official release announcements & developer exploration through the API.
5757

5858
### Why are there different versions of docs per version of each host app?
@@ -88,6 +88,23 @@ Have something to add? Please [open a PR](https://github.com/aenhancers/Types-fo
8888

8989
---
9090

91+
## Publish New Versions
92+
93+
To publish a new version of this project on npm for use in projects, please follow the steps below:
94+
95+
**1. Auth and Access**
96+
97+
- Ensure you are logged in to your npmjs.com account with `npm login` and follow the prompts to complete your login
98+
- Ensure your npmjs.com account has access to publish to the npm package, if not, reach out to an admin for access
99+
100+
**2. Version and Publish**
101+
102+
- Version up the `package.json`
103+
- Run `npm publish`
104+
- Push the commit with the new version to GitHub
105+
106+
---
107+
91108
## More typings
92109

93110
- [Adobe's offical typings](https://github.com/Adobe-CEP/Samples/tree/master/TypeScript/typings)

0 commit comments

Comments
 (0)