Skip to content

Commit a40fc7d

Browse files
committed
removing yarn and adding acknowledgement in readme
1 parent 80b6be0 commit a40fc7d

1 file changed

Lines changed: 26 additions & 19 deletions

File tree

README-sdk-dev.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ It is intended for BB2 team members or others performing SDK development work.
1212

1313
npm recommends install node using nvm (node version manager), for install instruction, check out: https://github.com/nvm-sh/nvm
1414

15-
1615
```
1716
check nvm version:
1817
nvm -v
@@ -102,6 +101,7 @@ cd my_proj
102101
yarn init
103102
...
104103
```
104+
105105
Setting npm config global settings will make subsequently created pacakge projects 'private'.
106106

107107
Note that publishing package 'private' is a npm option that requires payment.
@@ -110,31 +110,38 @@ Note that publishing package 'private' is a npm option that requires payment.
110110

111111
1. Consuming from npm registry:
112112

113-
```
114-
mkdir my_proj
115-
cd my_proj
116-
yarn init
117-
yarn add cms-bluebutton-sdk
113+
```
114+
mkdir my_proj
115+
cd my_proj
116+
yarn init
117+
yarn add cms-bluebutton-sdk
118118
119-
continue adding other dependencies, e.g. express, ts-node, etc., ...
119+
continue adding other dependencies, e.g. express, ts-node, etc., ...
120120
121-
yarn add express @types/express ts-node
122-
yarn add <other dependencies>
123-
```
121+
yarn add express @types/express ts-node
122+
yarn add <other dependencies>
123+
```
124124

125125
2. Consuming from a local SDK repository (as a good test before publishing):
126126

127-
After built and generated typescript types (needed if to be consumed by typescript project), the sdk can be consumed by other projects as shown by below example:
127+
After built and generated typescript types (needed if to be consumed by typescript project), the sdk can be consumed by other projects as shown by below example:
128128

129-
```
130-
mkdir my_proj
131-
cd my_proj
132-
yarn init
133-
yarn add <path to local cms-bluebutton-sdk local repository base directory>
129+
```
130+
mkdir my_proj
131+
cd my_proj
132+
yarn init
133+
yarn add <path to local cms-bluebutton-sdk local repository base directory>
134+
135+
continue adding other dependencies, e.g. express, ts-node, etc., ...
134136
135-
continue adding other dependencies, e.g. express, ts-node, etc., ...
137+
yarn add express @types/express ts-node
138+
yarn add <other dependencies>
139+
```
136140

137-
yarn add express @types/express ts-node
138-
yarn add <other dependencies>
141+
# It is known that there are traces of yarn being used in this repo, however Snyk currently blocks the merge of yarn 1.22.22 despite it being the latest version due to the fact that there is a security vulnerability. The steps listed here can still be followed after running:
142+
143+
```
144+
npm install yarn
139145
```
140146

147+
# In the future, we would like to move to using only a single package manager.

0 commit comments

Comments
 (0)