From 318d99fdd4d72f01a5dc4e6c8579ff986a49d548 Mon Sep 17 00:00:00 2001 From: janniks Date: Tue, 25 Jan 2022 15:24:25 +0100 Subject: [PATCH] chore: fix outdated links --- README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index bd0f958f..3bc398a2 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ -# Stacks.js [![CircleCI](https://img.shields.io/circleci/project/blockstack/stacks.js/master.svg)](https://circleci.com/gh/blockstack/stacks.js/tree/master) +# Stacks.js [![CircleCI](https://img.shields.io/circleci/project/hirosystems/stacks.js/master.svg)](https://circleci.com/gh/hirosystems/stacks.js/tree/master) This repo is home to the Stacks.js libraries which provide everything you need to work with the [Stacks blockchain](https://www.stacks.co/what-is-stacks). -- [`@stacks/auth`](https://github.com/blockstack/stacks.js/tree/master/packages/auth) Construct and decode authentication requests for Stacks apps. -- [`@stacks/storage`](https://github.com/blockstack/stacks.js/tree/master/packages/storage) Store and fetch files with Gaia, the decentralized storage system. -- [`@stacks/transactions`](https://github.com/blockstack/stacks.js/tree/master/packages/transactions) Construct, decode transactions and work with Clarity smart contracts on the Stacks blockchain. -- [`@stacks/cli`](https://github.com/blockstack/stacks.js/tree/master/packages/cli) Command line interface to interact with auth, storage and Stacks transactions. -- [`@stacks/stacking`](https://github.com/blockstack/stacks.js/tree/master/packages/stacking) Library for PoX stacking. -- [`@stacks/keychain`](https://github.com/blockstack/stacks.js/tree/master/packages/keychain) Create and manage keys/wallets for the Stacks blockchain. -- [`@stacks/network`](https://github.com/blockstack/stacks.js/tree/master/packages/network) Network and API library for working with Stacks blockchain nodes. -- [`@stacks/encryption`](https://github.com/blockstack/stacks.js/tree/master/packages/encryption) Encryption functions used by Stacks.js packages. -- [`@stacks/profile`](https://github.com/blockstack/stacks.js/tree/master/packages/profile) Functions for manipulating user profiles. -- [`@stacks/common`](https://github.com/blockstack/stacks.js/tree/master/packages/common) Common utilities used by Stacks.js packages. -- [`@stacks/bns`](https://github.com/blockstack/stacks.js/tree/master/packages/bns) Library for interacting with the BNS contract. -- [`@stacks/wallet-sdk`](https://github.com/blockstack/stacks.js/tree/master/packages/wallet-sdk) Library for building wallets for the Stacks blockchain. +- [`@stacks/auth`](https://github.com/hirosystems/stacks.js/tree/master/packages/auth) Construct and decode authentication requests for Stacks apps. +- [`@stacks/storage`](https://github.com/hirosystems/stacks.js/tree/master/packages/storage) Store and fetch files with Gaia, the decentralized storage system. +- [`@stacks/transactions`](https://github.com/hirosystems/stacks.js/tree/master/packages/transactions) Construct, decode transactions and work with Clarity smart contracts on the Stacks blockchain. +- [`@stacks/cli`](https://github.com/hirosystems/stacks.js/tree/master/packages/cli) Command line interface to interact with auth, storage and Stacks transactions. +- [`@stacks/stacking`](https://github.com/hirosystems/stacks.js/tree/master/packages/stacking) Library for PoX stacking. +- [`@stacks/keychain`](https://github.com/hirosystems/stacks.js/tree/master/packages/keychain) Create and manage keys/wallets for the Stacks blockchain. +- [`@stacks/network`](https://github.com/hirosystems/stacks.js/tree/master/packages/network) Network and API library for working with Stacks blockchain nodes. +- [`@stacks/encryption`](https://github.com/hirosystems/stacks.js/tree/master/packages/encryption) Encryption functions used by Stacks.js packages. +- [`@stacks/profile`](https://github.com/hirosystems/stacks.js/tree/master/packages/profile) Functions for manipulating user profiles. +- [`@stacks/common`](https://github.com/hirosystems/stacks.js/tree/master/packages/common) Common utilities used by Stacks.js packages. +- [`@stacks/bns`](https://github.com/hirosystems/stacks.js/tree/master/packages/bns) Library for interacting with the BNS contract. +- [`@stacks/wallet-sdk`](https://github.com/hirosystems/stacks.js/tree/master/packages/wallet-sdk) Library for building wallets for the Stacks blockchain. See `README` in each package directory for installation instructions and usage. ## Migrating from blockstack.js -To migrate your app from blockstack.js to stacks.js follow the steps in the [migration guide](https://github.com/blockstack/stacks.js/tree/master/migration-guide.md). +To migrate your app from blockstack.js to stacks.js follow the steps in the [migration guide](https://github.com/hirosystems/stacks.js/tree/master/migration-guide.md). ## Development: environment setup @@ -38,12 +38,14 @@ This repo uses Lerna [hoisting](https://github.com/lerna/lerna/blob/main/doc/hoi In order to install a new dependency to a package, the [`lerna add`](https://github.com/lerna/lerna/tree/main/commands/add) command must be used, rather than `npm install `. For example, the following command installs `lodash` as a dependency to the `@stacks/storage` package: + ```shell # Run within the root directory npm run lerna -- add lodash --scope @stacks/storage ``` Add `--dev` to install as a development dependency: + ```shell npm run lerna -- add lodash --scope @stacks/storage --dev ``` @@ -54,7 +56,7 @@ Documentation for the Stacks.js packages is located [here](https://stacks-js-git ## Contributing -Github issues marked [help-wanted](https://github.com/blockstack/stacks.js/labels/help-wanted) +Github issues marked [help-wanted](https://github.com/hirosystems/stacks.js/labels/help-wanted) are great places to start. Please ask in a github issue or discord before embarking on larger issues that aren't labeled as help wanted or adding additional functionality so that we can make sure your contribution can be included!