From 9b8b5b119e328d20ad698190e05bb3ebfe0608ca Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Tue, 15 Jan 2019 16:04:58 -0500 Subject: [PATCH] Add community documentation Update license, add fields to package.json, add C* files, rearrange the Readme. --- CODE_OF_CONDUCT.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 9 ++++++ LICENSE | 2 +- README.md | 31 +++++++++++--------- package.json | 7 +++++ 5 files changed, 108 insertions(+), 14 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..b64f6db --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,73 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [community@orbitdb.org](mailto:community@orbitdb.org), which goes to all members of the @OrbitDB community team, or to [richardlitt@orbitdb.org](mailto:richardlitt@orbitdb.org), which goes only to [@RichardLitt](https://github.com/RichardLitt) or to [haadcode@orbitdb.org](mailto:haadcode@orbitdb.org), which goes only to [@haadcode](https://github.com/haadcode). All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e5ba0d8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +# Contribute + +Please contribute! Here are some things that would be great: + +- [Open an issue!](https://github.com/orbitdb/example-orbitdb-todomvc/issues/new) +- Open a pull request! +- Say hi! :wave: + +Please abide by the [Code of Conduct](CODE_OF_CONDUCT.md). diff --git a/LICENSE b/LICENSE index db171bb..f19b999 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2017-2018 Haja Networks Oy +Copyright (c) 2017-2019 Haja Networks Oy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 7c02ca9..f26cb81 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# TodoMVC with OrbitDB +# Example OrbitDB TodoMVC > Serverless and collaborative Todo lists TodoMVC application using [OrbitDB](https://github.com/orbitdb/orbit-db) as a database for the todo list and [IPFS](https://github.com/ipfs/js-ipfs) as the storage and networking. This is an example to demonstrate how OrbitDB enables multi-user, real-time and serverless editing of a dataset. -***Work in progress*** +Status: ***Work in progress***. **[LIVE DEMO](https://ipfs.io/ipfs/QmTJGHccriUtq3qf3bvAQUcDUHnBbHNJG2x2FYwYUecN43/)** @@ -12,16 +12,26 @@ TodoMVC application using [OrbitDB](https://github.com/orbitdb/orbit-db) as a da

+## Background + +This example is based on [React TodoMVC](https://github.com/tastejs/todomvc/tree/master/examples/react). + +- Initializing OrbitDB and IPFS happens in [store](https://github.com/haadcode/example-orbitdb-todomvc/blob/master/src/store.js) +- OrbitDB calls happen in [model](https://github.com/haadcode/example-orbitdb-todomvc/blob/master/src/todoModel.js) +- The database and app are hooked together in [app](https://github.com/haadcode/example-orbitdb-todomvc/blob/master/src/app.jsx#L188) + ## Install -``` + +```sh git clone cd repo/ npm install npm run build ``` -## Run -``` +## Usage + +```sh npm start ``` @@ -31,18 +41,13 @@ Open your browser at http://127.0.0.1:8080 To collaborate on a TODO list, open the same url in *another browser or incognito window*. You should see the TODO lists sync automatically. -## More Info - -This example is based on [React TodoMVC](https://github.com/tastejs/todomvc/tree/master/examples/react). - -- Initializing OrbitDB and IPFS happens in [store](https://github.com/haadcode/example-orbitdb-todomvc/blob/master/src/store.js) -- OrbitDB calls happen in [model](https://github.com/haadcode/example-orbitdb-todomvc/blob/master/src/todoModel.js) -- The database and app are hooked together in [app](https://github.com/haadcode/example-orbitdb-todomvc/blob/master/src/app.jsx#L188) ## Contribute We'd be happy have contributions! If you find any issues, have suggestions for new features or would like to improve the project, please open an issue. +For specific guidelines for contributing to this repository, check out the [Contributing guide](CONTRIBUTING.md). For more on contributing to OrbitDB in general, take a look at the [@OrbitDB welcome repository](https://github.com/orbitdb/welcome). Please note that all interactions in @orbitdb fall under our [Code of Conduct](CODE_OF_CONDUCT.md). + ## License -[MIT](LICENSE) © 2017-2018 Haja Networks Oy +[MIT](LICENSE) © 2017-2019 Haja Networks Oy diff --git a/package.json b/package.json index 501e71d..d0d3d5f 100644 --- a/package.json +++ b/package.json @@ -19,6 +19,13 @@ "devDependencies": { "http-server": "^0.10.0" }, + "homepage": "https://github.com/orbitdb/example-orbitdb-todomvc", + "bugs": "https://github.com/orbitdb/example-orbitdb-todomvc/issues", + "keywords": [ + "orbitdb", + "example", + "todomvc" + ], "scripts": { "build": "./build.sh", "start": "http-server -c-1 & open http://127.0.0.1:8080/index.html & wait",