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

Add more documentation #9

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing to OpenBazaar

Anyone is free to contribute to OpenBazaar. The process and guidelines for contributing are similar to those for [Bitcoin Core](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md).

Many of the OpenBazaar core developers (including the lead maintainer) are currently hired by OB1 but over time as the OpenBazaar ecosystem grows, there will hopefully be many more contributors affiliated with other organizations or independent.

To make a contribution to any of the OpenBazaar GitHub repositories, you should fork the repository, create a topic branch and then submit a pull request when you have completed your work.

To ensure the highest probability of your pull request being merged, it is best to discuss what you intend to contribute with core developers/other contributors on the OpenBazaar [Slack](http://slack.openbazaar.org)

If you would like to add a new feature rather than just a bug fix, you may need to follow the OBIP (OpenBazaar Improvement Proposal). More information on the OBIP process can be found [here](https://github.com/OpenBazaar/obips).

The OpenBazaar client is coded in Javascript. The server is coded in Go. If you code in the above languages, we encourage you to contribute!




2 changes: 1 addition & 1 deletion docs/core_values.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ The protocol is designed to be censorship resistant and to offer privacy to its

A long term goal of OpenBazaar is to be cryptocurrency and blockchain agnostic. Limited resources and user experience considerations will restrict progress on this front in the short term.

The project is guided by the processes of other successful open source projects (Bitcoin, Linux etc). If you would like features to be added to the protocol, it is possible to submit OBIPs (OpenBazaar Improvement Plans) after discussing them with the OpenBazaar core developers.
The project is guided by the processes of other successful open source projects (Bitcoin, Linux etc). If you would like features to be added to the protocol, it is possible to submit [OBIPs](https://github.com/OpenBazaar/obips) (OpenBazaar Improvement Plans) after discussing them with the OpenBazaar core developers.


5 changes: 5 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# FAQ

Can you switch between accounts on the same machine?

You can switch between two accounts. An account is basically a server, so you would need to run multiple servers. If you are using the bundled app, that already comes with a server, so for your second server, you can download the standalone server and run that on different ports and from a different data directory. Then in the client you just make a separate server configuration for the second server and toggling between the two can be done with one click.
16 changes: 16 additions & 0 deletions docs/history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# History of OpenBazaar

The Story
In April 2014 at a secretive Toronto hackathon a project called "Dark Market" was created. Amir Taaki lead a small team of developers to build a proof of concept for a decentralized marketplace. The software was completely peer to peer with no central organization controlling it. The Dark Market entry won the hackathon, but Amir and his team decided not to continue work on the project.

Brian Hoffman talked to Amir about Dark Market and learned they weren't going to continue development. He liked the idea of a decentralized marketplace, but didn't like the sole focus on darknet markets, so he forked the project and renamed it OpenBazaar

The idea of a permissionless marketplace was powerful, and people around the world joined Brian to help build this open source software. In September this team released the first test version of the software.

Over the next few months the team continued improving the software and got an encouraging response from the Bitcoin community. They visited FOSSDEM (Free Open Source Software Developers European Meeting) in Brussels early in 2015, and presented the project to an enthusiastic crowd. Brian and a few core members of the team decided that it was time to turn the project from a part-time, volunteer effort into a serious, well-funded campaign to bring free trade to the world.

They founded a company, OB1, with a $1 million venture capital investment from Union Square Ventures and Andreessen Horowitz, and immediately began hiring developers to build a better version of the software from the ground up.

In April 2016 the first full release of the software was published, and tens of thousands of people around the world downloaded OpenBazaar and began buying and selling with each other directly, using Bitcoin.

The initial team's work secured them a $3 million second round investment in the fall of 2016. Building on their ground-breaking work in version 1, an expanded OB1 set to work on OpenBazaar 2, with the aim of making trade free for even more people around the world.
Loading