bump readme

v1
Tony Olagbaiye 3 years ago
parent d5a009f547
commit 60db9faf1b
No known key found for this signature in database
GPG Key ID: 9E2FF3BDEBDFC910

@ -17,24 +17,23 @@
[[https://github.com/bqv/weechat-xmpp/blob/master/LICENSE][file:https://img.shields.io/github/license/bqv/weechat-xmpp.svg]] [[https://github.com/bqv/weechat-xmpp/blob/master/LICENSE][file:https://img.shields.io/github/license/bqv/weechat-xmpp.svg]]
[[https://github.com/bqv/weechat-extras/][file:https://img.shields.io/badge/weechat--extras-xmpp-blue.svg]] [[https://github.com/bqv/weechat-extras/][file:https://img.shields.io/badge/weechat--extras-xmpp-blue.svg]]
| Status: | Aaaaaaaaaaaaaaaaa | | Status: | XMPP for power users and digital masochists |
| Location: | [[http://github.com/bqv/weechat-xmpp]] | | Location: | [[http://github.com/bqv/weechat-xmpp]] |
| Version: | 0.1.0 | | Version: | 0.1.1 |
| Disclaimer: | I'm lazy | | Disclaimer: | I'm lazy and unashamedly clinically insane |
* Description * Description
A weechat plugin in C to extend the chat client to A weechat plugin in C to extend the chat client to
support XMPP and ideally a maximal set of XEPs. support XMPP and a currently minimal but ideally maximal
set of XEPs.
* Usage * Usage
1. Start with =/xmpp register= for instructions on how 1. Start with =/xmpp add=, use =/help xmpp= for instructions.
to obtain a token, or if you already have a token, use
=/xmpp register <token>=.
2. Use =/xmpp connect <workspace-name>= with the name 2. Use =/xmpp connect <account-name>= with the name set at
returned by register add-time.
* Installing * Installing
@ -42,9 +41,9 @@
* Dependencies * Dependencies
- libstrophe (static, submodule) - libstrophe (dynamic, dependency)
- json-c (static, submodule) - libxml2 (dynamic, dependency)
- weechat (>= v1.7) - weechat (>= v2.5)
* Building * Building
@ -54,19 +53,19 @@
make make
make install make install
#+end_src #+end_src
Do *NOT* run make install as root, it installs the plugin to your Do *NOT* run make install as root, it installs the plugin to your
local weechat plugins directory local weechat plugins directory
* Development * Development
I use emacs for development of this, although I am also a fan of vim. I use emacs for development of this, although I am also a fan of vim.
My debug build process involves static analysis with clang and cppcheck, My debug build process involves static analysis with clang and cppcheck,
and dynamic analysis with address-sanitizer and leak-sanitizer. and dynamic analysis with address-sanitizer and leak-sanitizer.
My debug evaluation process involves gdb/mi run with the arguments My debug evaluation process involves gdb/mi run with the arguments
=-ex "handle SIGPIPE nostop noprint pass" --args weechat -a 2>asan.log= =-ex "handle SIGPIPE nostop noprint pass" --args weechat -a 2>asan.log=
since part of weechat and it's default plugins use SIGPIPE as control. since part of weechat and it's default plugins use SIGPIPE as control.
I have no real requests for style of pull requests besides a wish that I have no real requests for style of pull requests besides a wish that
you keep vaguely to the style I have adopted for this project. you keep vaguely to the style I have adopted for this project.
@ -74,8 +73,16 @@
* Tasks * Tasks
** TODO [#A] Implement basic functionality (milestone v0.1) ** DONE [#A] Implement basic functionality (milestone v0.1)
** TODO [#A] Implement essential events (milestone v0.2) * [x] Connecting
* [x] Pretty-printing stanzas
* [x] Receiveing and formatting PMs to a dedicated buffer
* [x] Responding to PMs and formatting responses
** TODO [#A] Implement essential functionality (milestone v0.2)
* [ ] MUCs
* [ ] OMEMO presence
* [ ] OMEMO messages
* [ ] MUC PMs
** TODO [#B] Implement completion engine (milestone v0.3) ** TODO [#B] Implement completion engine (milestone v0.3)
** TODO [#D] Close all issues (milestone v1.0) ** TODO [#D] Close all issues (milestone v1.0)

@ -597,3 +597,9 @@ struct t_channel_member *channel__add_member(struct t_account *account,
return member; return member;
} }
void channel__send_message(struct t_account *account, struct t_channel *channel,
const char *to, const char *message)
{
}

@ -95,23 +95,7 @@ int message_handler(xmpp_conn_t *conn, xmpp_stanza_t *stanza, void *userdata)
weechat_printf(channel->buffer, "<-(%s)- %s: %s", to, from, intext); weechat_printf(channel->buffer, "<-(%s)- %s: %s", to, from, intext);
reply = xmpp_stanza_reply(stanza);
if (xmpp_stanza_get_type(reply) == NULL)
xmpp_stanza_set_type(reply, "chat");
replytext = (char *)malloc(strlen(" received!") + strlen(intext) + 1);
strcpy(replytext, intext);
strcat(replytext, " received!");
xmpp_free(account->context, intext); xmpp_free(account->context, intext);
xmpp_message_set_body(reply, replytext);
xmpp_send(conn, reply);
xmpp_stanza_release(reply);
weechat_printf(channel->buffer, "-> %s: %s",
weechat_config_string(account->options[ACCOUNT_OPTION_JID]),
replytext);
free(replytext);
return 1; return 1;
} }

@ -7,7 +7,7 @@
#define weechat_plugin weechat_xmpp_plugin #define weechat_plugin weechat_xmpp_plugin
#define WEECHAT_XMPP_PLUGIN_NAME "xmpp" #define WEECHAT_XMPP_PLUGIN_NAME "xmpp"
#define WEECHAT_XMPP_PLUGIN_VERSION "0.1" #define WEECHAT_XMPP_PLUGIN_VERSION "0.1.1"
extern struct t_weechat_plugin *weechat_xmpp_plugin; extern struct t_weechat_plugin *weechat_xmpp_plugin;

Loading…
Cancel
Save