Skip to content
This repository has been archived by the owner on Aug 31, 2021. It is now read-only.

Commit

Permalink
Update links in README to be relative to current branch
Browse files Browse the repository at this point in the history
  • Loading branch information
elizabethengelman committed May 10, 2019
1 parent 8dc9ddf commit 5479151
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@

## Table of Contents
1. [Background](../staging/README.md#background)
1. [Dependencies](../staging/README.md#dependencies)
1. [Install](../staging/README.md#install)
1. [Usage](../staging/README.md#usage)
1. [Tests](../staging/README.md#tests)
1. [API](../staging/README.md#API)
1. [Contributing](../staging/README.md#contributing)
1. [License](../staging/README.md#license)
1. [Background](../README.md#background)
1. [Dependencies](../README.md#dependencies)
1. [Install](../README.md#install)
1. [Usage](../README.md#usage)
1. [Tests](../README.md#tests)
1. [API](../README.md#API)
1. [Contributing](../README.md#contributing)
1. [License](../README.md#license)


## Background
Expand All @@ -28,7 +28,7 @@ querying an Ethereum node and then persisting core data into a Postgres database
query for and transform log event and storage data for specifically configured smart contract addresses. Exposing data is a matter of getting
data from VulcanizeDB's underlying Postgres database and making it accessible.

![VulcanizeDB Overview Diagram](../documentation-updates/documentation/diagrams/vdb-overview.png)
![VulcanizeDB Overview Diagram](../documentation/diagrams/vdb-overview.png)

## Dependencies
- Go 1.11+
Expand All @@ -39,9 +39,9 @@ data from VulcanizeDB's underlying Postgres database and making it accessible.


## Install
1. [Building the project](../staging/README.md#building-the-project)
1. [Setting up the database](../staging/README.md#setting-up-the-database)
1. [Configuring a synced Ethereum node](../staging/README.md#configuring-a-synced-ethereum-node)
1. [Building the project](../README.md#building-the-project)
1. [Setting up the database](../README.md#setting-up-the-database)
1. [Configuring a synced Ethereum node](../README.md#configuring-a-synced-ethereum-node)

### Building the project
Download the codebase to your local `GOPATH` via:
Expand Down Expand Up @@ -111,7 +111,7 @@ As mentioned above, VulcanizeDB's processes can be split into three categories:
### Data syncing
To provide data for transformations, raw Ethereum data must first be synced into VulcanizeDB.
This is accomplished through the use of the `headerSync`, `sync`, or `coldImport` commands.
These commands are described in detail [here](../documentation-updates/documentation/sync.md).
These commands are described in detail [here](../documentation/sync.md).

### Data transformation
Data transformation uses the raw data that has been synced into Postgres to filter out and apply transformations to
Expand All @@ -122,16 +122,16 @@ Custom transformers:
- Generic Contract Transformer: Generic contract transformation can be done using a built-in command,
`contractWatcher`, which transforms contract events provided the contract's ABI is available. It also
provides some state variable coverage by automating polling of public methods, with some restrictions.
`contractWatcher` is described further [here](../documentation-updates/documentation/generic-transformer.md).
`contractWatcher` is described further [here](../documentation/generic-transformer.md).

- Custom Transformers: In many cases custom transformers will need to be written to provide
more comprehensive coverage of contract data. In this case we have provided the `compose`, `execute`, and
`composeAndExecute` commands for running custom transformers from external repositories. Documentation on how to write,
build and run custom transformers as Go plugins can be found
[here](../documentation-updates/documentation/custom-transformers.md).
[here](../documentation/custom-transformers.md).

### Exposing the data
[Postgraphile](https://www.graphile.org/postgraphile/) is used to expose GraphQL endpoints for our database schemas, this is described in detail [here](../staging/documentation/postgraphile.md).
[Postgraphile](https://www.graphile.org/postgraphile/) is used to expose GraphQL endpoints for our database schemas, this is described in detail [here](../documentation/postgraphile.md).


## Tests
Expand All @@ -148,7 +148,7 @@ Contributions are welcome!

VulcanizeDB follows the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct).

For more information on contributing, please see [here](../documentation/contributing.md).
For more information on contributing, please see [here](documentation/contributing.md).

## License
[AGPL-3.0](../staging/LICENSE) © Vulcanize Inc

0 comments on commit 5479151

Please sign in to comment.