chore: migrate packager repository metadata to ScCNv5
This commit is contained in:
9 files changed
+19
-20
No files matched your search
@@ -3,7 +3,7 @@
|
||||
## Installing
|
||||
|
||||
```bash
|
||||
npm install --save-exact @luyifei2011/tw-packager
|
||||
npm install --save-exact @sccn/tw-packager
|
||||
```
|
||||
|
||||
We suggest that you use `--save-exact` (or, with yarn, `--exact`) to make sure you always install the same version. This is important because we don't promise API compatibility across even minor updates.
|
||||
@@ -14,7 +14,7 @@ We suggest that you use `--save-exact` (or, with yarn, `--exact`) to make sure y
|
||||
|
||||
The Node.js API is still in beta.
|
||||
|
||||
There are no promises of API stability between updates even across minor updates. Always pin to an exact version and don't update without testing. We don't go out of our way to break the API, but we don't let it stop us from making changes. We try to mention noteworthy changes in the [GitHub releases](https://github.com/TurboWarp/packager/releases) changelog.
|
||||
There are no promises of API stability between updates even across minor updates. Always pin to an exact version and don't update without testing. We don't go out of our way to break the API, but we don't let it stop us from making changes. We try to mention noteworthy changes in the [GitHub releases](https://github.com/ScCNv5/packager/releases) changelog.
|
||||
|
||||
### Release cadence
|
||||
|
||||
@@ -34,7 +34,7 @@ The Node.js module as published on npm is not intended to work in a browser rega
|
||||
|
||||
Large assets such as Electron binaries are not stored in this repository and will be downloaded from a remote server on demand. While we aren't actively removing old files, we can't promise they will exist forever. Downloads are validated with a SHA-256 checksum and cached locally.
|
||||
|
||||
Large assets are cached in `node_modules/@luyifei2011/tw-packager/.packager-cache`. You may want to periodically clean this folder.
|
||||
Large assets are cached in `node_modules/@sccn/tw-packager/.packager-cache`. You may want to periodically clean this folder.
|
||||
|
||||
## Using the API
|
||||
|
||||
@@ -43,7 +43,7 @@ See demo.js or demo-simple.js for a full example.
|
||||
First, you can import the module like this:
|
||||
|
||||
```js
|
||||
const Packager = require('@luyifei2011/tw-packager');
|
||||
const Packager = require('@sccn/tw-packager');
|
||||
```
|
||||
|
||||
### Load a project
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
|
||||
// You should use require('@luyifei2011/tw-packager') instead
|
||||
// You should use require('@sccn/tw-packager') instead
|
||||
// We use a strange require() in this demo because we use this to test the API internally
|
||||
const Packager = require('../dist/packager');
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ const fs = require('fs');
|
||||
const path = require('path');
|
||||
const fetch = require('cross-fetch').default;
|
||||
|
||||
// You should use require('@luyifei2011/tw-packager') instead
|
||||
// You should use require('@sccn/tw-packager') instead
|
||||
// We use a strange require() in this demo because we use this to test the API internally
|
||||
const Packager = require('../dist/packager');
|
||||
|
||||
|
||||
Reference in new issue
Block a user