Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

Deprecate sdk repo #45

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Deprecate sdk repo #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c46b54
upgrade package-lock to v2
rhelmer Apr 24, 2022
dafc7b5
note about moving repos
rhelmer May 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 1 addition & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,3 @@
# @mozilla/rally-sdk

This is the Rally partner support library, used to manage the lifecycle of Rally studies.

This library is used in the [Rally Study Template](https://github.com/mozilla-rally/study-template).

## TypeScript vs. JS

This project is written in [TypeScript](https://www.typescriptlang.org/), which you may use directly from your TypeScript code, or you may use the TypeScript compiler to build `rally.js`.

## Building `rally.js`

First, install dependencies:

```bash
npm install
```

Then, build `rally.js`:

```bash
npm run build
```

## Manual testing using `npm link`
Manual testing can be done as follows:

1. Run `npm link` in this directory (`rally-sdk`)
2. In the directory of the testing grounds (e.g. the [study-template](https://github.com/mozilla-rally/study-template)), run `npm link "@mozilla/rally-sdk"`. This will make the test project use the local version of `@mozilla/rally-sdk`, automatically tracking any change to it.

And to undo the linking:

3. Run `npm unlink "@mozilla/rally-sdk"` in the testing directory.
4. Run `npm unlink` in the `support/` directory.
This project has moved to: https://github.com/mozilla-rally/rally/tree/master/extensions/sdk
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be main not master now that we renamed

Also, maybe preface with "This repo is no longer being maintained"

Loading