Skip to content

Commit 0eb66f7

Browse files
committed
Add installation instructions
Now that splunk-mode has been released on MELPA, should add details on how to install.
1 parent 3a9b114 commit 0eb66f7

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
11
<h1 align="center">splunk-mode</h1>
22

3-
Syntax highlighting for Splunk in Emacs
3+
[![MELPA Status](https://melpa.org/packages/splunk-mode-badge.svg)](https://melpa.org/#/splunk-mode)
4+
[![MELPA Stable Status](https://stable.melpa.org/packages/splunk-mode-badge.svg)](https://stable.melpa.org/#/splunk-mode)
5+
[![Build Status](https://github.com/jakewilliami/splunk-mode/actions/workflows/test.yml/badge.svg)](https://github.com/jakewilliami/splunk-mode/actions/workflows/test.yml)
6+
7+
[Emacs](https://www.gnu.org/software/emacs/) major mode for editing [Splunk SPL](https://splunk.com/) source code.
8+
9+
## Installation
10+
11+
### Installing from MELPA
12+
13+
`splunk-mode` is available on MELPA (as of [melpa/melpa#9005](https://github.com/melpa/melpa/pull/9005)). Using MELPA to install `splunk-mode` is the recommended way to use this package. You will need to:
14+
1. [Enable the MELPA repository](https://melpa.org/#/getting-started)
15+
2. Enable the package by adding the following lines to your Emacs init file (e.g., `~/.emacs`):
16+
17+
```elisp
18+
(package-install 'splunk-mode)
19+
(require 'splunk-mode)
20+
```
21+
22+
### Installing from Source
23+
24+
To get the latest version of `splunk-mode`, clone this repository and then use:
25+
```elisp
26+
(add-to-list 'load-path "<path to splunk mode>")
27+
(require 'splunk-mode)
28+
```

0 commit comments

Comments
 (0)