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.

Sign up for GitHub

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

Jump to bottom

Improve ReadMe #4

Closed
15 tasks
JavierCane opened this issue Feb 11, 2019 · 3 comments
Closed
15 tasks

Improve ReadMe #4

JavierCane opened this issue Feb 11, 2019 · 3 comments
Assignees
@santakadev
Labels
feature New feature or request
Milestone
1.0

Comments

@JavierCane
Copy link
Member

README.md sections (##)

  • 📜 Table of Contents
  • 💡 What does P2P Editor do?
  • 🤔 Why P2P?
  • 🏗️ Architecture
    • Communications (Swarm & WebRTC)
    • Append only DB (Hypercore & Merkel Tree)
    • Storage (RAM)
    • Signalhub (Distribute connections)
    • Ace (Editor)
  • 🚀 Environment setup
    • 🐳 Docker environment
    • ✅ Run the tests
  • ℹ️ About
  • 🤝 Contributing
  • ⚖️ License

Inspiration
@JavierCane JavierCane added the feature New feature or request label Feb 11, 2019
@JavierCane JavierCane added this to the 1.0 milestone Feb 11, 2019
@JavierCane
Copy link
Member Author

Hi!

We've improved the standard README.md files structure making it mobile friendly. Here you have an example.

Hope it helps on the README.md bootstrapping 😊🚀

santakadev added a commit that referenced this issue Feb 16, 2019
@santakadev
use codelytv responsive readme skeleton #4
c6ea4d2
santakadev added a commit that referenced this issue Feb 16, 2019
@santakadev
add environment seupt section #4
fb28a91
@santakadev santakadev mentioned this issue Feb 16, 2019
Merged
@santakadev
Copy link
Contributor

Sketch of p2p editor architecture
p2p-editor-architecture

@JavierCane
Copy link
Member Author

It would be awesome to include this picture inside some assets/ folder as architecture_diagram.jpg or whatever, and embed it from the README.md in the PR: #18

If you want to polish it a bit, you can use a https://www.draw.io diagram, but this is optional and can be a further step 🙂

santakadev added a commit that referenced this issue Feb 24, 2019
@santakadev
#4 improve readme
28154b2
@santakadev santakadev mentioned this issue Feb 24, 2019
Closed
3 tasks
santakadev added a commit that referenced this issue Feb 24, 2019
@santakadev
#4 improve readme
ca202ae
santakadev added a commit that referenced this issue Feb 24, 2019
@santakadev
#4 improve readme
f4f84d4
santakadev added a commit that referenced this issue Feb 28, 2019
@santakadev
#4 improve readme
2880fa8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@santakadev santakadev

Labels
feature New feature or request
Projects
None yet
Milestone
1.0
Development

No branches or pull requests
2 participants
@JavierCane @santakadev