Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 668/documentation improvements #669

Merged
merged 41 commits into from
Apr 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
b58e88d
Creating list of prerequisites
jamiehewitt15 Mar 17, 2021
f469cc3
adding installation command in testing flow
jamiehewitt15 Mar 17, 2021
4102883
creaitng learn more section in readme + new MD files
jamiehewitt15 Mar 17, 2021
21c12cf
creating instructions for wallets
jamiehewitt15 Mar 17, 2021
4d2e9ec
adding addition links to readme
jamiehewitt15 Mar 17, 2021
d38ed65
saving placeholders
jamiehewitt15 Mar 17, 2021
880d4a4
WIP content added for paramenters.md readme
jamiehewitt15 Mar 17, 2021
637900b
adding WIP content for services.md readme
jamiehewitt15 Mar 17, 2021
d5828a1
adding content to overview readme
jamiehewitt15 Mar 17, 2021
1d2f84a
updating dependancies in simple flow quickstart
jamiehewitt15 Mar 18, 2021
d98fc9d
updating simpleflow quickstart code & dependancies
jamiehewitt15 Mar 18, 2021
0b8eb53
updates to marketplace quickstart code snippet
jamiehewitt15 Mar 18, 2021
f8ca241
fixing issues with creating datatoken in simple flow quickstart
jamiehewitt15 Mar 19, 2021
2ba2261
updating the simplefloe quickstartt steps
jamiehewitt15 Mar 22, 2021
9205aba
adding steps for getting set up
jamiehewitt15 Mar 22, 2021
899b926
Adding template code to quickstart
jamiehewitt15 Mar 22, 2021
891d214
Quickstart: minting 100 tokens code added
jamiehewitt15 Mar 22, 2021
60d4cf1
Quickstart: transfering tokens from ALice to Bob
jamiehewitt15 Mar 22, 2021
3f8e072
Quickstart: adding steps for publishing a dataset
jamiehewitt15 Mar 22, 2021
4f61a60
Quickstart: adding steps for downloading a dataset
jamiehewitt15 Mar 22, 2021
bad3d10
Marketplace Quickstart: adding initial steps
jamiehewitt15 Mar 22, 2021
35d494f
Marketplace Quickstart: adding steps for publishing dataset
jamiehewitt15 Mar 22, 2021
209a1f3
Marketplace Quickstart: allowing marketplace to send tokens
jamiehewitt15 Mar 22, 2021
bf34f9e
Marketplace Quickstart: adding marketplace address
jamiehewitt15 Mar 22, 2021
02cd9d0
Marketplace Quickstart: marketplace withdraws datatoken allowance
jamiehewitt15 Mar 22, 2021
e9f39bf
Overiew: adding all asset functions
jamiehewitt15 Mar 23, 2021
e6359e5
Overiew readme: adding all pool functions
jamiehewitt15 Mar 23, 2021
89743c2
Overiew readme: adding all exchange functions
jamiehewitt15 Mar 23, 2021
a31826b
Overiew readme: adding all compute functions
jamiehewitt15 Mar 23, 2021
2cc57d4
Marketplace quickstart: Bob acquires tokens
jamiehewitt15 Mar 23, 2021
efbbfc6
Marketplace quickstart: Bob downloads data + extensions
jamiehewitt15 Mar 23, 2021
34ea9f2
minor fixes
jamiehewitt15 Mar 23, 2021
fecc267
Readme: adding links to discord and creating github issues
jamiehewitt15 Mar 24, 2021
5a3fbab
adding link to marketplace flow + fixing spelling mistake
jamiehewitt15 Mar 24, 2021
0049686
adding link to marketplace flow + fixing spelling mistake
jamiehewitt15 Mar 24, 2021
64d6c0e
Pull from origin main
jamiehewitt15 Mar 24, 2021
bab7b46
fixing dependancy issue
jamiehewitt15 Mar 24, 2021
ea22d15
Pull from origin main
jamiehewitt15 Apr 13, 2021
fe17c14
adding beginners guide
jamiehewitt15 Apr 13, 2021
cd75793
code formatting
jamiehewitt15 Apr 13, 2021
645f005
Merge branch 'main' into issue-668/documentation-improvements
kremalicious Apr 13, 2021
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
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,15 @@ With ocean.js, you can:

ocean.js is part of the [Ocean Protocol](https://oceanprotocol.com) toolset.

This is in alpha state and you can expect running into problems. If you run into them, please open up a [new issue](/issues).
This is in alpha state and you can expect running into problems. If you run into them, please open up a [new issue](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=&labels=bug&template=bug_report.md&title=).

- [📚 Prerequisites](#-prerequisites)
- [🏗 Installation](#-installation)
- [🏄 Quickstart](#-quickstart)
- [Beginners Guide](#beginners-guide)
- [Simple Flow](#simple-flow)
- [Marketplace Flow](#marketplace-flow)
- [📖 Learn More](#learn-more)
- [🦑 Development](#-development)
- [✨ Code Style](#-code-style)
- [👩‍🔬 Testing](#-testing)
Expand All @@ -40,6 +43,11 @@ This is in alpha state and you can expect running into problems. If you run into
- [Production](#production)
- [🏛 License](#-license)

## 📚 Prerequisites
- node.js ([Install from here](https://nodejs.org/en/download/))
- Docker ([Managed as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/))
- A Unix based operating system (Mac or Linux)

## 🏗 Installation

```bash
Expand Down Expand Up @@ -67,6 +75,11 @@ async function init() {
return ocean
}
```
### Beginners Guide

This introduction is aimed at developers who are completely new to blockchain, no coding experience is required.

[Go to beginners guide](docs/beginners_guide.md)

### Simple Flow

Expand All @@ -80,13 +93,26 @@ This batteries-included flow includes metadata, multiple services for one datato

[Go to marketplace flow](docs/quickstart_marketplace.md)

### 📖 Learn more

- [Get test OCEAN](docs/get-test-OCEAN.md) - from rinkeby
- [Understand config parameters](docs/parameters.md) - envvars vs files
- [Learn about off-chain services](docs/services.md) - Ocean Provider for data services, Aquarius metadata store
- [Learn about wallets](docs/wallets.md) - on generating, storing, and accessing private keys
- [Get an overview of ocean.js](docs/overview.md) - key modules and functions

If you have any difficulties with the quickstarts, or if you have further questions about how to use ocean.js please reach out to us on [Discord](https://discord.gg/TnXjkR5).

If you notice any bugs or issues with Ocean.js please [open an issue on github](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=&labels=bug&template=bug_report.md&title=).

## 🦑 Development

The project is authored with TypeScript and compiled with `tsc`.

To start compiler in watch mode:

```bash
npm install
npm start
```

Expand Down
Loading