Skip to content
This repository has been archived by the owner on Dec 10, 2020. It is now read-only.

Commit

Permalink
Added deprecation note to README
Browse files Browse the repository at this point in the history
  • Loading branch information
holgerd77 authored Dec 10, 2020
1 parent c31acaf commit 36902f3
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
## DEPRECATED

This repository has been deprecated.

We are targeting to deliver browser-friendly versions of the libraries along published package releases. If you are running into problems please open an issue on the respective repository.

Questions?

[![Discord][discord-badge]][discord-link]

# ethereumjs - Browser Builds

This repository contains browser builds of the following ``ethereumjs`` libraries:
Expand All @@ -16,10 +26,6 @@ They are built using [browserify](browserify.org) with a known set of working de
For every library/build collection there is a larger plain source version also including the source mappings
(e.g. ``ethereumjs-vm-x.x.x.js``) and a minified version for use in production (e.g. ``ethereumjs-vm-x.x.x.min.js``).

**Note:**

This repository was just lately (October 2017) revived. Currently all builds are considered ``experimental`` in terms of API stability, functionality and security!

## Usage

In your web application, include only one of the builds from the `dist` directory. All exports will be available under the global `ethereumjs`.
Expand Down Expand Up @@ -48,3 +54,6 @@ For creating new builds:
2. Reinstall/update local ``node_modules`` packages
3. Run `npm run build` to generate new set of builds


[discord-badge]: https://img.shields.io/static/v1?logo=discord&label=discord&message=Join&color=blue
[discord-link]: https://discord.gg/TNwARpR

0 comments on commit 36902f3

Please sign in to comment.