Skip to content

Commit bf1f54a

Browse files
committed
doc: adjust to reflect the new changes
- No more `setup` call - Instructions for the lazy package manager
1 parent 6fed399 commit bf1f54a

File tree

1 file changed

+26
-11
lines changed

1 file changed

+26
-11
lines changed

README.md

+26-11
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Forem.nvim
22

3-
<p align="center">This plugin integrates Neovim with Forem platforms (for example, dev.to)</p>
3+
<p align="center">This plugin integrates Neovim with Forem platforms like [dev.to](https://dev.to)</p>
44

55
https://user-images.githubusercontent.com/12272702/175755820-a2b93f4b-fd5c-416b-8b9e-d981335ef75c.mov
66

@@ -38,20 +38,37 @@ https://user-images.githubusercontent.com/12272702/175755866-62be0b6c-31b2-4f45-
3838

3939
## Installation
4040

41-
Using [packer](https://github.com/wbthomason/packer.nvim):
41+
### Using [lazy](https://github.com/folke/lazy.nvim):
42+
43+
```lua
44+
{
45+
"Massolari/forem.nvim",
46+
dependencies = {
47+
"nvim-lua/plenary.nvim",
48+
"nvim-telescope/telescope.nvim",
49+
"rcarriga/nvim-notify"
50+
}
51+
}
52+
```
53+
54+
### Using [packer](https://github.com/wbthomason/packer.nvim):
4255

4356
```lua
4457
use {
4558
"Massolari/forem.nvim",
4659
requires = {
4760
"nvim-lua/plenary.nvim",
48-
"nvim-telescope/telescope.nvim"
61+
"nvim-telescope/telescope.nvim",
62+
"rcarriga/nvim-notify"
4963
}
5064
}
5165
```
5266

5367
## Setup
5468

69+
> [!NOTE]
70+
> These instructions are for the dev.to platform.
71+
5572
First, you need to generate an API key for the DEV platform.
5673

5774
For dev.to, you can do it in [the end of the extension's page](https://dev.to/settings/extensions)
@@ -62,17 +79,15 @@ With your API key, you just need to set it into the `FOREM_API_KEY` environment
6279

6380
The plugin has the following commands and functions available in `forem-nvim` module:
6481

65-
| function | command | description |
66-
| --- | --- | --- |
67-
| `feed()` | `:Forem feed` | Shows fresh articles from the feed, then you can read it in Neovim or open it in the browser |
68-
| `my_articles()` | `:Forem my_articles` | Shows all your articles, then you can pick one to edit |
69-
| `new_article()` | `:Forem new_article` | Asks for a title, then creates an article with the given title and open it to edit |
70-
| `open_by_url()` | `:Forem open_by_url` | Asks for an URL, then opens the article |
82+
| function | command | description |
83+
| --------------- | -------------------- | -------------------------------------------------------------------------------------------- |
84+
| `feed()` | `:Forem feed` | Shows fresh articles from the feed, then you can read it in Neovim or open it in the browser |
85+
| `my_articles()` | `:Forem my_articles` | Shows all your articles, then you can pick one to edit |
86+
| `new_article()` | `:Forem new_article` | Asks for a title, then creates an article with the given title and open it to edit |
87+
| `open_by_url()` | `:Forem open_by_url` | Asks for a URL, then opens the article |
7188

7289
After you save the buffer it'll automatically be saved in the cloud.
7390

74-
**Note: these functions will only be available after the `setup` call**
75-
7691
## Contributing
7792

7893
Please, don't hesitate in contributing by creating issues and opening pull requests.

0 commit comments

Comments
 (0)