Skip to content
Snippets Groups Projects
Unverified Commit fc6e61f1 authored by Ryan Smith's avatar Ryan Smith Committed by GitHub
Browse files

docs: Corrects docs for translator.

parent e2f1d430
No related branches found
No related tags found
No related merge requests found
## Installation and Upgrading
You'll need to install [Composer](https://getcomposer.org/) first.
- Install with `composer require learninglocker/moodle-xapi-translator`.
- Update with `composer update learninglocker/moodle-xapi-translator`.
## Supported Events
Mapping for moodle event names to translator event classes can be found in the [Controller](../src/Controller.php).
......@@ -70,14 +63,14 @@ When adding new events or modifying existing events, we recommend that you follo
If this is your first pull request, you need to follow the steps below.
1. Click the "Fork" button (top right of Github). Github will fork (copy) this repository as your own so you can make changes.
2. Run `git remote set-url origin https://github.com/YOUR_USERNAME/Moodle-xAPI-Translator.git` (replacing `YOUR_USERNAME` for your Github username).
2. Run `git remote set-url origin https://github.com/YOUR_USERNAME/moodle-logstore_xapi.git` (replacing `YOUR_USERNAME` for your Github username).
Once this is done, you can then follow the steps for [subsequent pull requests](#subsequent-pull-requests) below.
### Subsequent Pull Requests
1. Run `git add -A; git commit -am "DESCRIPTION";` to commit your changes (replacing `DESCRIPTION` with a description of what you've changed).
2. Run `git push` to push your commits to your forked repository.
3. Go to "https://github.com/YOUR_USERNAME/Moodle-xAPI-Translator/pulls" (replacing `YOUR_USERNAME` for your Github username).
3. Go to "https://github.com/YOUR_USERNAME/moodle-logstore_xapi/pulls" (replacing `YOUR_USERNAME` for your Github username).
4. Click the "New pull request" button to begin creating your pull request.
5. Click the "Create pull request" button (twice) to confirm the creation of your pull request.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment