diff --git a/README.md b/README.md index b9af0e3..ddfb564 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,40 @@ text-encoding ============== +This is a fork of https://github.com/inexorabletash/text-encoding, which +has been marked as deprecated in the npm registry. + +``` +npm info text-encoding + +text-encoding@0.7.0 | (Unlicense OR Apache-2.0) | deps: none | versions: 11 +Polyfill for the Encoding Living Standard's API. +https://github.com/inexorabletash/text-encoding + +DEPRECATED ⚠️ - no longer maintained + +keywords: encoding, decoding, living standard + +dist +.tarball: https://registry.npmjs.org/text-encoding/-/text-encoding-0.7.0.tgz +.shasum: f895e836e45990624086601798ea98e8f36ee643 +.integrity: sha512-oJQ3f1hrOnbRLOcwKz0Liq2IcrvDeZRHXhd9RgLrsT+DjWY/nty1Hi7v3dtkaEYbPYe0mUoOfzRrMwfXXwgPUA== +.unpackedSize: 649.6 kB + +maintainers: +- inexorabletash + +dist-tags: +latest: 0.7.0 + +published a year ago by inexorabletash +``` + +This fork is published as `@sinonjs/text-encoding` and will be available as long +as it is in use by `@sinonjs` packages. + +
+ This is a polyfill for the [Encoding Living Standard](https://encoding.spec.whatwg.org/) API for the Web, allowing encoding and decoding of textual data to and from Typed Array buffers @@ -16,7 +50,7 @@ Basic examples and tests are included. ### Install ### -There are a few ways you can get and use the `text-encoding` library. +There are a few ways you can get and use the `@sinonjs/text-encoding` library. ### HTML Page Usage ### @@ -34,7 +68,7 @@ you should probably use a different library. #### Package Managers #### -The package is published to **npm** and **bower** as `text-encoding`. +The package is published to **npm** as `@sinonjs/text-encoding`. Use through these is not really supported, since they aren't used by the developer of the library. Using `require()` in interesting ways probably breaks. Patches welcome, as long as they don't break the diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..05c8fb8 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,4 @@ +``` +$ npm version patch # or minor, major, 0.8.1, ... +$ npm publish +``` diff --git a/bower.json b/bower.json deleted file mode 100644 index d268df8..0000000 --- a/bower.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "name": "text-encoding", - "version": "0.7.0", - "homepage": "https://github.com/inexorabletash/text-encoding", - "authors": [ - "Joshua Bell ", - "Rick Eyre ", - "Eugen Podaru ", - "Filip Dupanović ", - "Anne van Kesteren ", - "Author: Francis Avila ", - "Michael J. Ryan ", - "Pierre Queinnec ", - "Zack Weinberg " - ], - "description": "Polyfill for the Encoding Living Standard's API", - "main": [ "lib/encoding.js", "lib/encoding-indexes.js" ], - "keywords": [ - "decoding", - "encoding", - "living", - "standards" - ], - "license": "(Unlicense OR Apache-2.0)", - "ignore": [ - "**/.*", - "test", - "*examples*.html" - ] -} diff --git a/package.json b/package.json index ffc3155..5c7a2e8 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,8 @@ { - "name": "text-encoding", + "name": "@sinonjs/text-encoding", + "scripts": { + "postpublish": "git push --follow-tags" + }, "author": "Joshua Bell ", "contributors": [ "Joshua Bell ", @@ -12,7 +15,7 @@ "Pierre Queinnec ", "Zack Weinberg " ], - "version": "0.7.0", + "version": "0.7.3", "description": "Polyfill for the Encoding Living Standard's API.", "main": "index.js", "files": [ @@ -22,7 +25,7 @@ ], "repository": { "type": "git", - "url": "https://github.com/inexorabletash/text-encoding.git" + "url": "https://github.com/sinonjs/text-encoding.git" }, "keywords": [ "encoding", @@ -30,8 +33,8 @@ "living standard" ], "bugs": { - "url": "https://github.com/inexorabletash/text-encoding/issues" + "url": "https://github.com/sinonjs/text-encoding/issues" }, - "homepage": "https://github.com/inexorabletash/text-encoding", + "homepage": "https://github.com/sinonjs/text-encoding", "license": "(Unlicense OR Apache-2.0)" } diff --git a/test/README.md b/test/README.md new file mode 100644 index 0000000..7b985d9 --- /dev/null +++ b/test/README.md @@ -0,0 +1,19 @@ +# Running tests + +These tests are provided as a runnable webpage for running in a browser +using a W3C official test harness. + +To run the tests, start a web server that serves the root directory +and open test/index.html. + +``` +# From the top root directory execute these commands +git submodule init +git submodule update --checkout +python -m SimpleHTTPServer & +``` + +Then open `http://localhost:8000/test` + + + diff --git a/test/tests.html b/test/index.html similarity index 100% rename from test/tests.html rename to test/index.html diff --git a/test/testharness.js b/test/testharness.js index e92dfa2..e7a80b1 160000 --- a/test/testharness.js +++ b/test/testharness.js @@ -1 +1 @@ -Subproject commit e92dfa2b98494dff2f801be3e5b4dac24392f6db +Subproject commit e7a80b151358184505514cc20e79444263656b92