From 6333fbd8933f3e47eac5167c6288a4c05715594c Mon Sep 17 00:00:00 2001 From: Andrew Kelley Date: Tue, 1 Jan 2013 21:02:07 -0500 Subject: [PATCH] update README --- README.md | 17 ++++++++--------- package.json | 2 +- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index baf54c8..19b8629 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,18 @@ # minecraft protocol -Parse minecraft -This project simply provides protocol support. You'll want to use a higher -level library to write bots. - -Hopefully eventually we can merge -[mineflayer](https://github.com/superjoe30/mineflayer) with this project. +Parse and serialize minecraft packets, plus authentication and encryption. ## Features - * (TODO #8) Parse all packets and emit `packet` events with packet fields as JavaScript + * Parses all packets and emits `packet` events with packet fields as JavaScript objects. * Send a packet by supplying fields as a JavaScript object. - * (TODO #9) Send keep-alive packet at the correct interval. - * Supports encryption, no encryption (TODO #2), online, and offline (TODO #1) modes. + * Supports authenticating and logging in. + - Supports encryption enabled + - Supports encryption disabled (TODO #2) + - Supports online mode + - Supports offline mode (TODO #1) + * Send keep-alive packet at the correct interval. * Reasonable amount of test coverage (TODO #3) * Optimized for rapidly staying up to date with Minecraft protocol updates. diff --git a/package.json b/package.json index 29ccd3e..4e249fc 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "minecraft-protocol", "version": "0.0.0", - "description": "minecraft protocol", + "description": "Parse and serialize minecraft packets, plus authentication and encryption.", "main": "index.js", "scripts": { "test": "mocha"