<commit_before># Elfeed Emacs Web Feed Reader

Elfeed is a web feed reader for Emacs, inspired by
[notmuch](http://notmuchmail.org/). It supports both Atom and RSS and
is currently in beta.

Elfeed requires Emacs 24 (lexical closures).

The database is not yet persisted between Emacs instances, so don't
spend too much time manually tagging entries.

## Getting Started

It is recommended that you make a global binding for `elfeed`.

```el
(global-set-key (kbd "C-x w") 'elfeed)
```

Running the interactive function `elfeed` will pop up the
`*elfeed-search*` buffer, which will display feed items.

 * <kbd>g</kbd>: refresh view of the feed listing
 * <kbd>G</kbd>: fetch feed updates from the servers
 * <kbd>s</kbd>: update the search filter (see tags)

This buffer will be empty until you add your feeds to the
`elfeed-feeds` list and initiate an update with <kbd>M-x
elfeed-update</kbd> (or <kbd>G</kbd> in the Elfeed buffer). This will
populate the Elfeed database with entries.

From this buffer there are a number of ways to interact with entries.
Entries are selected by placing the point over an entry. Multiple
entries are selected at once by using an active region.

 * <kbd>b</kbd>: open selected entries in your browser (`browse-url`)
 * <kbd>y</kbd>: copy selected entries URL to the clipboard<commit_msg>Add an example to the README.<commit_after># Elfeed Emacs Web Feed Reader

Elfeed is a web feed reader for Emacs, inspired by
[notmuch](http://notmuchmail.org/). It supports both Atom and RSS and
is currently in beta.

Elfeed requires Emacs 24 (lexical closures).

The database is not yet persisted between Emacs instances, so don't
spend too much time manually tagging entries.

## Getting Started

It is recommended that you make a global binding for `elfeed`.

```el
(global-set-key (kbd "C-x w") 'elfeed)
```

Running the interactive function `elfeed` will pop up the
`*elfeed-search*` buffer, which will display feed items.

 * <kbd>g</kbd>: refresh view of the feed listing
 * <kbd>G</kbd>: fetch feed updates from the servers
 * <kbd>s</kbd>: update the search filter (see tags)

This buffer will be empty until you add your feeds to the
`elfeed-feeds` list and initiate an update with `M-x elfeed-update`
(or <kbd>G</kbd> in the Elfeed buffer). This will populate the Elfeed
database with entries.

```el
;; Somewhere in your .emacs file
(setq elfeed-feeds
      '("http://nullprogram.com/feeds/"
        "http://www.terminally-incoherent.com/blog/feed/"))
```

From this buffer there are a number of ways to interact with entries.
Entries are selected by placing the point over an entry. Multiple
entries are selected at once by using an active region.

 * <kbd>b</kbd>: open selected entries in your browser (`browse-url`)
 * <kbd>y</kbd>: copy selected entries URL to the clipboard
{'fraction_non_alphanumeric': 0.09381663113006397, 'fraction_numerical': 0.0014214641080312722, 'mean_word_length': 4.232342007434944, 'pattern_counts': {'":': 0, '<': 29, '<?xml version=': 0, '>': 29, 'https://': 0, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3328516', 'n_tokens_mistral': 875, 'n_tokens_neox': 830, 'n_words': 400}