Skip to content

Commit

Permalink
✨ update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
TodepSymbol committed Oct 26, 2021
1 parent 43fbe60 commit a529e80
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 50 deletions.
52 changes: 4 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,7 @@
[![@nuxtjs/strapi](https://strapi.nuxtjs.org/preview.png)](https://strapi.nuxtjs.org)
# @symbol-it/nuxt-strapi-axios | Fork from @nuxtjs/strapi

> [Strapi](https://strapi.io) module for [NuxtJS](https://nuxtjs.org) with axios
> Replace @nuxtjs/http by @nuxtjs/axios
# @nuxtjs/strapi
- [Native repository - Strapi Nuxtjs](https://strapi.nuxtjs.org)

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]

> [Strapi](https://strapi.io) module for [NuxtJS](https://nuxtjs.org)
- [ Release Notes](https://github.com/nuxt-community/strapi-module/releases)
- [📖  Read the documentation](https://strapi.nuxtjs.org)

## Features

- Authentication support
- RESTful methods
- Adaptive SDK for API entities
- Handle errors with hooks
- TypeScript support

[📖  Read the documentation](https://strapi.nuxtjs.org)

## Development

1. Clone this repository
2. Install dependencies using `yarn install` or `npm install`
3. Start development server using `yarn dev` or `npm run dev`

## License

[MIT License](./LICENSE)

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/strapi/latest.svg
[npm-version-href]: https://npmjs.com/package/@nuxtjs/strapi

[npm-downloads-src]: https://img.shields.io/npm/dt/@nuxtjs/strapi.svg
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/strapi

[github-actions-ci-src]: https://github.com/nuxt-community/strapi-module/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/nuxt-community/strapi-module/actions?query=workflow%3Aci

[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/strapi-module.svg
[codecov-href]: https://codecov.io/gh/nuxt-community/strapi-module

[license-src]: https://img.shields.io/npm/l/@nuxtjs/strapi.svg
[license-href]: https://npmjs.com/package/@nuxtjs/strapi
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"dev": "yarn nuxt-ts example",
"docs": "nuxt docs",
"lint": "eslint --ext .ts --ext .vue .",
"release": "yarn test && standard-version && yarn build && git push --follow-tags",
"release": "yarn test && standard-version && yarn build && git push --follow-tags && npm publish",
"test": "yarn lint && jest"
},
"dependencies": {
Expand Down
2 changes: 1 addition & 1 deletion test/module.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ describe('module', () => {

it('renders', async () => {
const { body } = await get('/')
expect(body).toContain('@nuxtjs/strapi')
expect(body).toContain('@symbol-it/nuxt-strapi-axios')
expect(body).toContain('http://localhost:1337')
})
})

0 comments on commit a529e80

Please sign in to comment.